Rework releases landing page into an overview#22873
Open
Conversation
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
taroface
requested changes
Mar 3, 2026
Contributor
taroface
left a comment
taroface
left a comment
There was a problem hiding this comment.
This is a nice improvement already. Blocking mainly for:
-
codeis being used instead ofcorein the liquid var, causing it to render as empty. I found two instances but there may be others. -
The discussion of "major" and "patch" versions gets confusing in a number of places, for reasons that predate this PR. I feel it's necessary to clarify those points, as it stands.
| {% else %}{% comment %}Begin GA-only content{% endcomment %} | ||
| {% if skippable == true %} | ||
| CockroachDB {{ page.major_version }} is an [Innovation Release]({% link releases/release-support-policy.md %}#support-types), which is optional for CockroachDB {{ site.data.products.advanced }}, CockroachDB {{ site.data.products.standard }}, and CockroachDB {{ site.data.products.core }} clusters but is required for CockroachDB {{ site.data.products.basic }}. | ||
| CockroachDB {{ page.major_version }} is an [Innovation Release]({% link releases/release-support-policy.md %}#support-types), which is optional for CockroachDB {{ site.data.products.advanced }} and {{ site.data.products.code }}. Innovation releases including {{ page.major_version }} are unavailable for CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters. |
Contributor
There was a problem hiding this comment.
{{ site.data.products.code }} is coming up empty in preview.
| ### Types of upgrades | ||
|
|
||
| - **Major-version upgrades**: A [major-version upgrade]({% link releases/index.md %}#major-releases), such as from v24.2 to v24.3, may include new features, updates to cluster setting defaults, and backward-incompatible changes. Performing a major-version upgrade requires an additional step to finalize the upgrade. | ||
| - **Major-version upgrades**: A [major-version upgrade]({% link releases/index.md %}#major-versions), such as from v24.2 to v24.3, may include new features, updates to cluster setting defaults, and backward-incompatible changes. Performing a major-version upgrade requires an additional step to finalize the upgrade. |
Contributor
There was a problem hiding this comment.
Optional nit: Could we use liquid vars to call out the latest and previous major release here, instead of hardcoding 24.2 and 24.3?
| {% else %}{% comment %}Begin GA-only content{% endcomment %} | ||
| {% if skippable == true %} | ||
| CockroachDB {{ page.major_version }} is an [Innovation Release]({% link releases/release-support-policy.md %}#support-types), which is optional for CockroachDB {{ site.data.products.advanced }}, CockroachDB {{ site.data.products.standard }}, and CockroachDB {{ site.data.products.core }} clusters but is required for CockroachDB {{ site.data.products.basic }}. | ||
| CockroachDB {{ page.major_version }} is an [Innovation Release]({% link releases/release-support-policy.md %}#support-types), which is optional for CockroachDB {{ site.data.products.advanced }} and {{ site.data.products.code }}. Innovation releases including {{ page.major_version }} are unavailable for CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters. |
Contributor
There was a problem hiding this comment.
I think this is a more informative link for this context:
Suggested change
| CockroachDB {{ page.major_version }} is an [Innovation Release]({% link releases/release-support-policy.md %}#support-types), which is optional for CockroachDB {{ site.data.products.advanced }} and {{ site.data.products.code }}. Innovation releases including {{ page.major_version }} are unavailable for CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters. | |
| CockroachDB {{ page.major_version }} is an optional [Innovation release]({% link releases/index.md %}#major-versions). This version can be skipped for CockroachDB {{ site.data.products.advanced }} and {{ site.data.products.core }} clusters. It is unavailable for CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters. |
| CockroachDB {{ page.major_version }} is an [Innovation Release]({% link releases/release-support-policy.md %}#support-types), which is optional for CockroachDB {{ site.data.products.advanced }}, CockroachDB {{ site.data.products.standard }}, and CockroachDB {{ site.data.products.core }} clusters but is required for CockroachDB {{ site.data.products.basic }}. | ||
| CockroachDB {{ page.major_version }} is an [Innovation Release]({% link releases/release-support-policy.md %}#support-types), which is optional for CockroachDB {{ site.data.products.advanced }} and {{ site.data.products.code }}. Innovation releases including {{ page.major_version }} are unavailable for CockroachDB {{ site.data.products.standard }} and CockroachDB {{ site.data.products.basic }} clusters. | ||
| {% else %} | ||
| CockroachDB {{ page.major_version }}{% if lts == true %} [(LTS)]({% link releases/release-support-policy.md %}#support-phases){% endif %} is a required [Regular Release]({% link releases/release-support-policy.md %}#support-types). |
Contributor
There was a problem hiding this comment.
Ditto
Suggested change
| CockroachDB {{ page.major_version }}{% if lts == true %} [(LTS)]({% link releases/release-support-policy.md %}#support-phases){% endif %} is a required [Regular Release]({% link releases/release-support-policy.md %}#support-types). | |
| CockroachDB {{ page.major_version }}{% if lts == true %} [(LTS)]({% link releases/release-support-policy.md %}#support-types){% endif %} is a required [Regular release]({% link releases/index.md %}#major-versions). |
| {% endif %} | ||
|
|
||
| To learn more about CockroachDB major versions and patches, refer to the [Releases Overview]({% link releases/index.md %}#overview). | ||
| To learn more about CockroachDB major versions and patches, refer to the [Releases Overview]({% link releases/index.md %}). |
Contributor
There was a problem hiding this comment.
Suggested change
| To learn more about CockroachDB major versions and patches, refer to the [Releases Overview]({% link releases/index.md %}). | |
| To learn more about CockroachDB major versions and patches, refer to [CockroachDB Releases Overview]({% link releases/index.md %}). |
|
|
||
| CockroachDB {{ site.data.products.cloud }} is a managed product that handles CockroachDB upgrades on your behalf, but still offers some flexibility over when to perform upgrades and which version to use. Version and upgrade support varies depending on the {{ site.data.products.cloud }} plan: | ||
|
|
||
| - CockroachDB {{ site.data.products.basic }} only supports **Regular releases**. Clusters are automatically upgraded to the next major regular version upon its GA release and receive regular patch updates. |
Contributor
There was a problem hiding this comment.
Suggested change
| - CockroachDB {{ site.data.products.basic }} only supports **Regular releases**. Clusters are automatically upgraded to the next major regular version upon its GA release and receive regular patch updates. | |
| - CockroachDB {{ site.data.products.basic }} only supports **Regular releases**. Clusters are automatically upgraded to the next regular GA release, and receive regular patch updates. |
| CockroachDB {{ site.data.products.cloud }} is a managed product that handles CockroachDB upgrades on your behalf, but still offers some flexibility over when to perform upgrades and which version to use. Version and upgrade support varies depending on the {{ site.data.products.cloud }} plan: | ||
|
|
||
| - CockroachDB {{ site.data.products.basic }} only supports **Regular releases**. Clusters are automatically upgraded to the next major regular version upon its GA release and receive regular patch updates. | ||
| - CockroachDB {{ site.data.products.standard }} only supports **Regular releases**. By default clusters are automatically upgraded to the next major version upon its GA release, with the option to handle the upgrade timing manually. Clusters receive regular patch updates. |
Contributor
There was a problem hiding this comment.
Suggested change
| - CockroachDB {{ site.data.products.standard }} only supports **Regular releases**. By default clusters are automatically upgraded to the next major version upon its GA release, with the option to handle the upgrade timing manually. Clusters receive regular patch updates. | |
| - CockroachDB {{ site.data.products.standard }} only supports **Regular releases**. By default, clusters are automatically upgraded to the next regular GA release, with the option to handle the upgrade timing manually. Clusters receive regular patch updates. |
|
|
||
| - CockroachDB {{ site.data.products.basic }} only supports **Regular releases**. Clusters are automatically upgraded to the next major regular version upon its GA release and receive regular patch updates. | ||
| - CockroachDB {{ site.data.products.standard }} only supports **Regular releases**. By default clusters are automatically upgraded to the next major version upon its GA release, with the option to handle the upgrade timing manually. Clusters receive regular patch updates. | ||
| - CockroachDB {{ site.data.products.advanced }} support both **Regular** and **Innovation** releases. |
Contributor
There was a problem hiding this comment.
Suggested change
| - CockroachDB {{ site.data.products.advanced }} support both **Regular** and **Innovation** releases. | |
| - CockroachDB {{ site.data.products.advanced }} supports both **Regular** and **Innovation** releases. |
| | Reserved | Intended for use by CockroachDB developers. Not supported for public use. | N/A | | ||
|
|
||
| Backward-incompatible changes to **stable APIs** are highlighted in the [release notes]({% link releases/index.md %}#production-releases) for major CockroachDB versions. Users are asked to [consider backward-incompatible changes before upgrading]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#review-breaking-changes) to a new CockroachDB version. | ||
| Backward-incompatible changes to **stable APIs** are highlighted in the [release notes]({% link releases/index.md %}) for major CockroachDB versions. Users are asked to [consider backward-incompatible changes before upgrading]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#review-breaking-changes) to a new CockroachDB version. |
Contributor
There was a problem hiding this comment.
This applies to all versions of this doc.
Suggested change
| Backward-incompatible changes to **stable APIs** are highlighted in the [release notes]({% link releases/index.md %}) for major CockroachDB versions. Users are asked to [consider backward-incompatible changes before upgrading]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#review-breaking-changes) to a new CockroachDB version. | |
| Backward-incompatible changes to **stable APIs** are highlighted in the [release notes]({% link releases/index.md %}#supported-releases) for major CockroachDB versions. Users are asked to [consider backward-incompatible changes before upgrading]({% link {{ page.version.version }}/upgrade-cockroach-version.md %}#review-breaking-changes) to a new CockroachDB version. |
|
|
||
| - [Support for restoring backups into a newer version](#support-for-restoring-backups-into-a-newer-version) | ||
| - [Support for long-term backup archival](#support-for-long-term-backup-archival) | ||
| - [See also](#see-also) |
Contributor
There was a problem hiding this comment.
I don't think this change is necessary?
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.
https://cockroachlabs.atlassian.net/browse/DOC-16115
https://cockroachlabs.atlassian.net/browse/DOC-16116
TODO on this page, not in scope for this PR: