-
Notifications
You must be signed in to change notification settings - Fork 473
Rework releases landing page into an overview #22873
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,6 +1,6 @@ | ||||||
| ### 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. | ||||||
|
|
||||||
| {% if page.path contains "cockroachcloud" %} | ||||||
| As of 2024, there are four major versions per year, where every second release is an [Innovation release]({% link cockroachcloud/upgrade-policy.md %}#innovation-releases). For CockroachDB {{ site.data.products.advanced }}, Innovation releases include all of the latest features but have shorter [support windows]({% link cockroachcloud/upgrade-policy.md %}#cockroachdb-cloud-support-policy) and can be skipped. | ||||||
|
|
@@ -17,7 +17,7 @@ | |||||
| For all CockroachDB {{ site.data.products.cloud }} clusters, production patch releases for a major version are automatically applied until the cluster is upgraded to a new major version. On an {{ site.data.products.advanced }} cluster, you have the option to defer patch updates for 30, 60, or 90 days if you have a [maintenance window]({% link cockroachcloud/advanced-cluster-management.md %}#set-a-maintenance-window) configured. | ||||||
| {% 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| {% if page.path contains "cockroachcloud" %} | ||||||
| ### Upgrade differences across Cloud plans | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,7 +8,7 @@ With the release of CockroachDB v23.1, we've added new capabilities in Cockroach | |
|
|
||
| <h3 id="v23-1-0-feature-highlights">Feature highlights</h3> | ||
|
|
||
| This section summarizes the most significant user-facing changes in v23.1.0. For a complete list of features and changes, including bug fixes and performance improvements, see the [release notes]({% link releases/index.md %}#testing-releases) for previous testing releases. You can also search for [what's new in v23.1 in our docs](https://www.cockroachlabs.com/docs/search?query=new+in+v23.1). | ||
| This section summarizes the most significant user-facing changes in v23.1.0. For a complete list of features and changes, including bug fixes and performance improvements, see the release notes for previous testing releases. You can also search for [what's new in v23.1 in our docs](https://www.cockroachlabs.com/docs/search?query=new+in+v23.1). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Confused why that link was removed, given that the content behind that link is still intact. The result is that we refer verbally to "release notes for previous testing releases" without pointing to them. I understand that we eventually want to remove them, but if this is prepping us for that step, can we save it until it happens? (This comment applies to all the changes below.) |
||
|
|
||
| {{site.data.alerts.callout_info}} | ||
| The features highlighted below are freely available in CockroachDB {{ site.data.products.core }} and do not require an [enterprise license]({% link v23.1/cockroach-demo.md %}) to test enterprise features in a local, temporary cluster. | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -90,7 +90,7 @@ no_highlights: {{ no_highlights }}<br /> | |||||
| CockroachDB {{ page.major_version }} is in active development, and the following [testing releases]({% link releases/index.md %}#release-types) are intended for testing and experimentation only, and are not qualified for production environments or eligible for support or uptime SLA commitments. When CockroachDB {{ page.major_version }} is Generally Available (GA), production releases will also be announced on this page. | ||||||
| {% 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this is a more informative link for this context:
Suggested change
|
||||||
| {% 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ditto
Suggested change
|
||||||
| {% endif %} | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,27 @@ | ||
| {%- assign versions = site.data.versions | where_exp: "versions", "versions.major_version != site.versions['dev']" | where_exp: "versions", "versions.major_version != site.versions['stable']" | map: "major_version" -%} | ||
| {%- comment -%} versions iterates through the list of major versions (e.g., v21.2) in _data/versions.csv and returns all releases that are not dev or stable. We then pull only the major version name instead of the whole dictionary with map: "major_version" {%- endcomment -%} | ||
| { | ||
| "title": "Latest Production Release", | ||
| "title": "Overview", | ||
| "urls": [ | ||
| "/releases/index.html", | ||
| "/releases/" | ||
| {% for v in versions %} | ||
| ,"/releases/{{ v }}.html" | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As we discussed, not sure if this is causing a releases/releases.md link to be generated, but that link gives a 404 and we should eliminate it if possible. |
||
| {% endfor %} | ||
| ] | ||
| }, | ||
| { | ||
| "title": "Latest Production Release ({{ site.versions["stable"] }})", | ||
| "urls": [ | ||
| "/releases/{{ site.versions["stable"] }}.html" | ||
| ] | ||
| }{% unless site.versions["stable"] == site.versions["dev"] %}, | ||
| { | ||
| "title": "Latest Testing Release", | ||
| "title": "Latest Testing Release ({{ site.versions["dev"] }})", | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| "urls": [ | ||
| "/releases/{{ site.versions["dev"] }}.html" | ||
| ] | ||
| }{% endunless %}, | ||
| { | ||
| "title": "CockroachDB Releases", | ||
| "urls": [ | ||
| "/releases/index.html", | ||
| "/releases/" | ||
| {% for v in versions %} | ||
| ,"/releases/{{ v }}.html" | ||
| {% endfor %} | ||
| ] | ||
| }, | ||
| { | ||
| "title": "Staged Release Process", | ||
| "urls": [ | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -28,7 +28,7 @@ Cockroach Labs has diagnosed the above-described problem, and is tracking progre | |||||
|
|
||||||
| We plan to improve this issue in an expedited patch version v21.2.1 in the coming days. This advisory will be updated after that release. | ||||||
|
|
||||||
| You can track releases on our [releases page](https://www.cockroachlabs.com/docs/releases#production-releases). | ||||||
| You can track releases on our [releases page](https://www.cockroachlabs.com/docs/releases). | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ## Mitigation | ||||||
|
|
||||||
|
|
||||||

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?