Skip to content

Commit

Permalink
Add intro to What's New pages and licensing section on Releases page
Browse files Browse the repository at this point in the history
  • Loading branch information
mikeCRL committed Jun 12, 2024
1 parent 9f82bc6 commit 5a2edc3
Show file tree
Hide file tree
Showing 17 changed files with 32 additions and 46 deletions.
10 changes: 10 additions & 0 deletions src/current/_includes/releases/whats-new-intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
On this page, you can read about changes and find downloads for all production and testing releases of CockroachDB {{ page.major_version }}.

- For key feature enhancements in {{ page.major_version }} and other upgrade considerations, refer to the notes for {% if page.major_version != 'v1.0' %}[{{ page.major_version }}.0](#{{ page.major_version | replace: '.', '-' }}-0){% else %}{{ page.major_version }} on this page.{% endif %}
- For details about release types, naming, and licensing, refer to the [Releases]({% link releases/index.md %}) page.
- Be sure to also review the [Release Support Policy]({% link releases/release-support-policy.md %}).
- After downloading a supported CockroachDB binary, learn how to [install CockroachDB](../{{ page.major_version }}/install-cockroachdb.html) or [upgrade your cluster](../{{ page.major_version }}/upgrade-cockroach-version.html).

Get future release notes emailed to you:

{% include_cached marketo.html %}
8 changes: 7 additions & 1 deletion src/current/releases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ After downloading a supported CockroachDB binary, learn how to [install Cockroac
- **Testing** releases are intended for testing and experimentation only, and are not qualified for production environments and not eligible for support or uptime SLA commitments. Testing releases allow you to begin testing and validating the next major version of CockroachDB early.
- **Experimental** binaries allow you to deploy and develop with CockroachDB on architectures that are not yet qualified for production use. Experimental binaries are not eligible for support or uptime SLA commitments, whether they are for testing releases or production releases.

For more details, refer to [Release Naming](#release-naming).
For more details, refer to [Release Naming](#release-naming). For information about applicable software licenses, refer to [Licenses](#licenses).

{{site.data.alerts.callout_danger}}
In CockroachDB v22.2.x and above, a cluster that is upgraded to an alpha binary of CockroachDB or a binary that was manually built from the `master` branch cannot subsequently be upgraded to a production release.
Expand Down Expand Up @@ -374,3 +374,9 @@ During development of a major version of CockroachDB, releases are produced acco
- Release candidates are produced after the series of beta releases and are nearly identical to what will become the initial generally available (GA) release. Release candidates have `rc` in the version name. Example: `v23.1.0-rc.1`.
- A major version's initial GA release is produced after the series of release candidates for a major version, and ends with `0`. Example: `v23.1.0`. GA releases are validated and suitable for production environments.
- Patch (maintenance) releases are produced after a major version's GA release, and are numbered sequentially. Example: `v23.1.13`.

## Licenses

Unless otherwise noted, all binaries available on this page are variously licensed under the Business Source License 1.1 (BSL), the CockroachDB Community License (CCL), and other licenses specified in the source code. To determine whether BSL or CCL applies to a CockroachDB feature, refer to the [Licensing FAQs](https://www.cockroachlabs.com/docs/stable/licensing-faqs) page under Feature Licensing. The default license for any feature that is not listed is the CCL.

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.
4 changes: 1 addition & 3 deletions src/current/releases/v1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ keywords: gin, gin index, gin indexes, inverted index, inverted indexes, acceler

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% unless vers.release_date == "N/A" or vers.release_date > today %}
To upgrade to {{ page.major_version }}, see [Upgrade to CockroachDB {{ page.major_version }}](https://www.cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version).
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v1.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ keywords: gin, gin index, gin indexes, inverted index, inverted indexes, acceler

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% unless vers.release_date == "N/A" or vers.release_date > today %}
To upgrade to {{ page.major_version }}, see [Upgrade to CockroachDB {{ page.major_version }}](https://www.cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version).
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v19.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ keywords: gin, gin index, gin indexes, inverted index, inverted indexes, acceler

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% unless vers.release_date == "N/A" or vers.release_date > today %}
To upgrade to {{ page.major_version }}, see [Upgrade to CockroachDB {{ page.major_version }}](https://www.cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version).
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v19.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ keywords: gin, gin index, gin indexes, inverted index, inverted indexes, acceler

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% unless vers.release_date == "N/A" or vers.release_date > today %}
To upgrade to {{ page.major_version }}, see [Upgrade to CockroachDB {{ page.major_version }}](https://www.cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version).
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ keywords: gin, gin index, gin indexes, inverted index, inverted indexes, acceler

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% unless vers.release_date == "N/A" or vers.release_date > today %}
To upgrade to {{ page.major_version }}, see [Upgrade to CockroachDB {{ page.major_version }}](https://www.cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version).
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v2.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ keywords: gin, gin index, gin indexes, inverted index, inverted indexes, acceler

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% unless vers.release_date == "N/A" or vers.release_date > today %}
To upgrade to {{ page.major_version }}, see [Upgrade to CockroachDB {{ page.major_version }}](https://www.cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version).
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v20.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ keywords: gin, gin index, gin indexes, inverted index, inverted indexes, acceler

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% unless vers.release_date == "N/A" or vers.release_date > today %}
To upgrade to {{ page.major_version }}, see [Upgrade to CockroachDB {{ page.major_version }}](https://www.cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version).
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v20.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ keywords: gin, gin index, gin indexes, inverted index, inverted indexes, acceler

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% unless vers.release_date == "N/A" or vers.release_date > today %}
To upgrade to {{ page.major_version }}, see [Upgrade to CockroachDB {{ page.major_version }}](https://www.cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version).
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v21.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ keywords: gin, gin index, gin indexes, inverted index, inverted indexes, acceler

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% unless vers.release_date == "N/A" or vers.release_date > today %}
To upgrade to {{ page.major_version }}, see [Upgrade to CockroachDB {{ page.major_version }}](https://www.cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version).
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v21.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ keywords: gin, gin index, gin indexes, inverted index, inverted indexes, acceler

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% unless vers.release_date == "N/A" or vers.release_date > today %}
To upgrade to {{ page.major_version }}, see [Upgrade to CockroachDB {{ page.major_version }}](https://www.cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version).
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v22.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ keywords: gin, gin index, gin indexes, inverted index, inverted indexes, acceler

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% unless vers.release_date == "N/A" or vers.release_date > today %}
To upgrade to {{ page.major_version }}, see [Upgrade to CockroachDB {{ page.major_version }}](https://www.cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version).
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v22.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@ keywords: gin, gin index, gin indexes, inverted index, inverted indexes, acceler

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% unless vers.release_date == "N/A" or vers.release_date > today %}
To upgrade to {{ page.major_version }}, see [Upgrade to CockroachDB {{ page.major_version }}](https://www.cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version).
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v23.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@ docs_area: releases

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% unless vers.release_date == "N/A" or vers.release_date > today %}
To upgrade to {{ page.major_version }}, see [Upgrade to CockroachDB {{ page.major_version }}](https://www.cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version).
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v23.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@ docs_area: releases

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% comment %}
{% unless vers.release_date == "N/A" or vers.release_date > today %}
Expand Down
4 changes: 1 addition & 3 deletions src/current/releases/v24.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ docs_area: releases

{% include releases/testing-release-notice.md major_version=vers %}

Get future release notes emailed to you:

{% include_cached marketo.html %}
{% include releases/whats-new-intro.md %}

{% comment %}
{% unless vers.release_date == "N/A" or vers.release_date > today %}
Expand Down

0 comments on commit 5a2edc3

Please sign in to comment.