Remove known limitations page #22325
Open
Conversation
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
Files changed:
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
|
❌ Cross-Version Link Check Failed Found 40 cross-version link violations that must be fixed: File:
|
❌ Deploy Preview for cockroachdb-docs failed. Why did it fail? →
|
mikeCRL
approved these changes
Jan 27, 2026
Contributor
mikeCRL
left a comment
mikeCRL
left a comment
There was a problem hiding this comment.
LGTM! Some suggestions for your consideration.
|
|
||
| {% include {{ page.version.version }}/sql/session-variable-precedence-order.md %} | ||
|
|
||
| ## Known Limitations |
Contributor
There was a problem hiding this comment.
Suggested change
| ## Known Limitations | |
| ## Known limitations |
We could make this consistent with the others (sentence case), while we're here
|
|
||
| {% include {{ page.version.version }}/sql/session-variable-precedence-order.md %} | ||
|
|
||
| ## Known Limitations |
Contributor
There was a problem hiding this comment.
Suggested change
| ## Known Limitations | |
| ## Known limitations |
We could make this consistent with the others (sentence case), while we're here
| <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 %} |
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?
|
|
||
| # 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
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.