Fix Version Notation and Add Dynamic Support for Version Categorization #19327
Conversation
This file contains 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
Contributor
mohini-crl
commented
Jan 28, 2025
mohini-crl
commented
- Updated version notation to ensure consistency by capitalizing version strings where necessary.
- Added dynamic logic to fetch and display supported and unsupported versions on release pages based on maint_supp_exp_date and asst_supp_exp_date.
…etching of supported and unsupported versions
Files changed:
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
taroface
requested changes
Jan 28, 2025
src/current/releases/index.md
Outdated
| @@ -400,7 +418,7 @@ macOS downloads are **experimental**. Experimental downloads are not yet qualifi | |||
| </section> | |||
|
|
|||
| <section class="filter-content" markdown="1" data-scope="windows"> | |||
| Windows 8 or higher is required. Windows downloads are **experimental**. Experimental downloads are not yet qualified for production use and not eligible for support or uptime SLA commitments, whether they are for testing releases or production releases. | |||
| Windows 8 or higher is required. Windows downloads are **experimental**. Experimental downloads are not yet qualified for production use and not eligible for support or uptime SLA commitments, whether they are for testing releases or production releases | |||
There was a problem hiding this comment.
Double-checking: this period was removed because it was generating double periods, right? In preview, it still shows one period at the end (which I think is correct).
| @@ -169,7 +169,7 @@ Innovation releases are not eligible for Assistance Support, and reach EOL at th | |||
| <sup id="lts-tbd">* : This major version will receive LTS patch releases, which will be listed on an additional row, upon their availability.</sup><br /> | |||
| <sup id="skippable">** : This major version is an optional innovation release and will not receive receive LTS patch releases. Innovation releases are EOL when Maintenance Support ends.</sup><br /> | |||
|
|
|||
| ## Unsupported versions | |||
| ## Unsupported Versions | |||
There was a problem hiding this comment.
Suggested change
| ## Unsupported Versions | |
| ## Unsupported versions |
This may be confusing, but we use sentence case (Only capitalize proper nouns) for page headings. Title case is used for page titles. (See style guide). This means the Support Phases and Support Types headings on this page should also be adjusted, but that can be addressed separately from this PR, since it's not part of your changes.
src/current/releases/index.md
Outdated
| @@ -604,6 +623,6 @@ All binaries available on this page released prior to the release date of 24.3.0 | |||
|
|
|||
| To review the CCL, refer to the [CockroachDB Community License](https://www.cockroachlabs.com/cockroachdb-community-license) page. You can find the applicable Business Source License or third party licenses by reviewing these in the `licenses` folder for the applicable version of CockroachDB in the GitHub repository [cockroachdb/cockroach](https://github.com/cockroachdb/cockroach). See individual files for details. | |||
|
|
|||
| ## Unsupported versions | |||
| ## Unsupported Versions | |||
There was a problem hiding this comment.
Suggested change
| ## Unsupported Versions | |
| ## Unsupported versions |
See my earlier comment.
src/current/releases/index.md
Outdated
| @@ -604,6 +623,6 @@ All binaries available on this page released prior to the release date of 24.3.0 | |||
|
|
|||
| To review the CCL, refer to the [CockroachDB Community License](https://www.cockroachlabs.com/cockroachdb-community-license) page. You can find the applicable Business Source License or third party licenses by reviewing these in the `licenses` folder for the applicable version of CockroachDB in the GitHub repository [cockroachdb/cockroach](https://github.com/cockroachdb/cockroach). See individual files for details. | |||
|
|
|||
| ## Unsupported versions | |||
| ## Unsupported Versions | |||
| [Here]({% link releases/unsupported-versions.md %}) are the versions of CockroachDB that are no longer supported | |||
There was a problem hiding this comment.
Note the extra line break to separate from the heading text.
Suggested change
| [Here]({% link releases/unsupported-versions.md %}) are the versions of CockroachDB that are no longer supported | |
| Release notes for unsupported CockroachDB versions are found on [Unsupported Versions]({% link releases/unsupported-versions.md %}). |
| @@ -15,7 +15,7 @@ docs_area: releases | |||
| {% assign released_versions = site.data.releases | map: "major_version" | uniq | reverse %} | |||
There was a problem hiding this comment.
I think this page needs a callout on the top to clarify that the versions aren't supported. Try this:
{{site.data.alerts.callout_danger}}
The CockroachDB versions on this page are no longer supported. For more information, refer to [Release Support Policy]({% link releases/release-support-policy.md %}#unsupported-versions). To download and learn about currently supported CockroachDB versions, refer to [CockroachDB Releases]({% link releases/index.md %}).
{{site.data.alerts.end}}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.