Remove known limitations page#22325
Merged
Merged
Conversation
Files changed:
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
|
✅ Cross-Version Link Check Passed All cross-version link issues have been resolved. Good job! |
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
mikeCRL
approved these changes
Jan 27, 2026
mikeCRL
left a comment
mikeCRL
left a comment
Contributor
There was a problem hiding this comment.
LGTM! Some suggestions for your consideration.
| <h4 id="v25-4-0-known-limitations">Known limitations</h4> | ||
|
|
||
| For information about new and unresolved limitations in CockroachDB v25.4, with suggested workarounds where applicable, refer to [Known Limitations]({% link v25.4/known-limitations.md %}). | ||
| {% include releases/v25.4/deprecations.md %} No newline at end of file |
Contributor
There was a problem hiding this comment.
I'm thinking we should have some note saying something like 'Known Limitations are now exclusively listed on applicable feature pages, and are no longer aggregated into a single page'.
If so, we could re-add the Known limitations heading after this, and just include that phrase there - just for v25.4 and v26.1.
WDYT?
Contributor
Author
There was a problem hiding this comment.
I'm wondering if @Flat5flat9 could weigh in here. I feel it depends how much we think our customers refer to this section when upgrading.
Contributor
Author
There was a problem hiding this comment.
@mikeCRL I discussed with @Flat5flat9 and we still want the Known Limitations section for each release to list the new limitations for that release -- this makes sense, and must have slipped my mind. So I've replaced this section with the new v25.4 new limitations, adding the usual commented-out placeholder block in case there are no new limitations (as might be the case in v26.1).
|
|
||
| # Removed Pages | ||
|
|
||
| - destination: releases/index.md |
Contributor
There was a problem hiding this comment.
If you go with my suggestion on v25.4.0.md to re-add the Known Limitations section to the What's New page [with a simple note under it about the change], then I think it's better to redirect to that, like this:
- destination: releases/v25.4.md#v25-4-0-known-limitations
sources: ['known-limitations.md']
versions: ['v25.4']
- destination: releases/v26.1.md#v26-1-0-known-limitations
sources: ['known-limitations.md']
versions: ['v26.1']
If not, then maybe it's better to just redirect to a search for Known Limitations: https://www.cockroachlabs.com/docs/search?query=%22Known+Limitations%22
Contributor
Author
There was a problem hiding this comment.
Updated as follows (see above comment; I also removed the version from the anchor link, since it's the only Known Limitations heading on the page):
- destination: ../releases/25.4.md#known-limitations
sources: ['known-limitations.md']
versions: ['v25.4']
taroface
force-pushed
the
remove-known-limitations-page
branch
from
6586bf6 to
7fd8826
Compare
1 task
taroface
force-pushed
the
remove-known-limitations-page
branch
2 times, most recently
from
875126b to
7d7094d
Compare
Co-authored-by: Mike Lewis <76072290+mikeCRL@users.noreply.github.com>
Co-authored-by: Mike Lewis <76072290+mikeCRL@users.noreply.github.com>
taroface
force-pushed
the
remove-known-limitations-page
branch
from
5cf9ff7 to
a570660
Compare
taroface
force-pushed
the
remove-known-limitations-page
branch
from
ec73b63 to
af503fa
Compare
taroface
force-pushed
the
remove-known-limitations-page
branch
from
af503fa to
cdbe802
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Remove Known Limitations page on v26.1 and v25.4 as follows:
known-limitations.mdinto dedicated includes.known-limitations.mdto the Releases page. (Open to other suggestions.)known-limitations.md.