Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…vation releases (WIP) (#18739)

Fixes DOC-10586, DOC-10587, REL-1220, DOC-10688, DOC-10692, DOC-10697

Co-authored-by: Mike Lewis <[email protected]>
Co-authored-by: Rich Loveland <[email protected]>
Co-authored-by: mikeCRL <[email protected]>
  • Loading branch information
4 people authored Aug 12, 2024
1 parent 6c58123 commit 9f95339
Show file tree
Hide file tree
Showing 22 changed files with 908 additions and 260 deletions.
2 changes: 1 addition & 1 deletion src/current/_config_cockroachdb.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
baseurl: /docs
current_cloud_version: v24.1
current_cloud_version: v24.2
destination: _site/docs
homepage_title: CockroachDB Docs
versions:
Expand Down
31 changes: 31 additions & 0 deletions src/current/_includes/latest-release-details.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{% comment %}
This is included by v24.2+ install-cockroachdb-*.md upgrade-cockroach-version.md
{% endcomment %}

{% assign DEBUG = false %}

{% assign rd = site.data.versions | where_exp: "rd", "rd.major_version == page.version.version" | first %}
{% assign latest = site.data.releases | where_exp: "latest", "latest.major_version == page.version.version" | sort: "release_date" | last %}

{% assign released = false %}
{% assign skippable = false %}
{% if rd.release_date != "N/A" and rd.maint_supp_exp_date != "N/A" %}
{% assign released = true %}
{% if rd.asst_supp_exp_date == "N/A" %}
{% assign skippable = true %}
{% endif %}
{% endif %}

{% if DEBUG == true %}
version: {{ rd }}<br /><br />
latest release: {{ latest }}<br /><br />
page version: {{ page.version }}<br /><br />
released: {{ released }}<br />
skippable: {{ skippable }}<br />
{% endif %}

CockroachDB {{ latest.major_version }} is the latest supported supported production release.{% if skippable == true %} It is an [Innovation release]({% link releases/release-support-policy.md %}#support-types) that is optional for CockroachDB {{ site.data.products.dedicated }} and CockroachDB {{ site.data.products.core }} but required for CockroachDB {{ site.data.products.serverless }}.{% else %} It is a required [Regular release]({% link releases/release-support-policy.md %}#support-types).{% endif %} To learn more, refer to [CockroachDB {{ latest.major_version }} Release Notes](https://cockroachlabs.com/docs/releases/{{ latest.major_version }}.html).

{% if page.version.version != blank and page.version.version != latest.major_version %}
**This page refers to CockroachDB {{ page.version.version }}, not {{ latest.major_version }}.**
{% endif %}
2 changes: 1 addition & 1 deletion src/current/_includes/releases/v20.1/v20.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,4 +130,4 @@ Docs | **"Hello World" Repos** | Added several language-specific [GitHub repos](
Docs | **Multi-Region Sample App and Tutorial** | Added a full-stack, multi-region sample application ([GitHub repo](https://github.com/cockroachlabs/movr-flask)) with an [accompanying tutorial](https://www.cockroachlabs.com/docs/v20.1/multi-region-overview) on building a multi-region application on a multi-region CockroachCloud cluster. Also added a [video demonstration](https://www.youtube.com/playlist?list=PL_QaflmEF2e8o2heLyIt5iDUTgJE3EPkp) as a YouTube playlist.
Docs | **Streaming Changefeeds to Snowflake Tutorial** | Added an [end-to-end tutorial](https://www.cockroachlabs.com/docs/cockroachcloud/stream-changefeed-to-snowflake-aws) on how to use an Enterprise changefeed to stream row-level changes from CockroachCloud to Snowflake, an online analytical processing (OLAP) database.
Docs | **Improved Backup/Restore Docs** | Updated the backup/restore docs to better separate [broadly applicable guidance and best practices](https://www.cockroachlabs.com/docs/v20.1/backup-and-restore) from more advanced topics.
Docs | **Release Support Policy** | Added a page explaining Cockroach Labs' [policy for supporting major releases of CockroachDB]({% link releases/release-support-policy.md %}), including the phases of support that each major release moves through, the currently supported releases, and an explanation of the [naming scheme]({% link releases/index.md %}#release-naming) used for CockroachDB.
Docs | **Release Support Policy** | Added a page explaining Cockroach Labs' [policy for supporting major releases of CockroachDB]({% link releases/release-support-policy.md %}), including the phases of support that each major release moves through, the currently supported releases, and an explanation of the [naming scheme]({% link releases/index.md %}#overview) used for CockroachDB.
67 changes: 58 additions & 9 deletions src/current/_includes/releases/whats-new-intro.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
{% comment %}Early in development, a new major-version directory may not
yet exist. Adapt some links in this situation.{% endcomment %}
{% assign DEBUG = false %}
{% assign branched = false %}
{% assign ancient = false %}
{% assign old = false %}
{% assign no_highlights = false %}
{% assign skippable = false %}
{% assign will_never_have_lts = false %}
{% assign lts = false %}
{% assign install_links = '' %}

{% comment %}Early in development, a new major-version directory may not
yet exist. Adapt some links in this situation.{% endcomment %}

{% for file in site.pages %}
{% unless branched == true %}
{% capture fpath %}{{ file.dir | remove:'/' }}{% endcapture %}
Expand All @@ -13,14 +19,28 @@
{% endunless %}
{% endfor %}

{% comment %}Some old pages need different links to install and upgrade pages{% endcomment %}
{% if page.major_version == 'v1.0' or page.major_version == 'v1.1' or page.major_version == 'v2.0' or page.major_version == 'v2.1' or page.major_version == 'v21.1' %}
{% comment %}Some old pages don't have feature highlights and won't get LTS{% endcomment %}
{% if page.major_version == 'v1.0' or
page.major_version == 'v1.1' or
page.major_version == 'v2.0' or
page.major_version == 'v2.1' or
page.major_version == 'v19.1' or
page.major_version == 'v19.2' or
page.major_version == 'v20.1' or
page.major_version == 'v20.2' or
page.major_version == 'v21.1' or
page.major_version == 'v21.2' or
page.major_version == 'v22.1' or
page.major_version == 'v22.2' %}
{% assign branched = true %}
{% assign ancient = true %}
{% assign no_highlights = true %}
{% assign will_never_have_lts = true %}
{% endif %}

{% if page.major_version == 'v1.0' or page.major_version == 'v1.1' or page.major_version == 'v2.0' or page.major_version == 'v2.1' or page.major_version == 'v21.1' %}
{% capture install_link %}[install CockroachDB](https://cockroachlabs.com/docs/{{ page.major_version}}/install-cockroachdb.html){% endcapture %}
{% capture install_sentence %}After downloading a supported CockroachDB binary, learn how to {{ install_link }}.{% endcapture %}
{% elsif page.major_version == 'v19.1' or page.major_version == 'v19.2' or page.major_version == 'v20.1' or page.major_version == 'v20.2' %}
{% assign branched = true %}
{% capture install_link %}[install CockroachDB](https://cockroachlabs.com/docs/{{ page.major_version}}/install-cockroachdb.html){% endcapture %}
{% capture upgrade_link %}[upgrade your cluster](https://cockroachlabs.com/docs/{{ page.major_version }}/upgrade-cockroach-version.html){% endcapture %}
{% capture install_sentence %}After downloading a supported CockroachDB binary, learn how to {{ install_link }} or {{ upgrade_link }}.{% endcapture %}
Expand All @@ -35,15 +55,44 @@
{% capture install_sentence %}After downloading a supported CockroachDB binary, learn how to {{ install_link }} or {{ upgrade_link }}.{% endcapture %}
{% endif %}

On this page, you can read about changes and find downloads for all production and testing releases of CockroachDB {{ page.major_version }}.
{% comment %}Is it skippable or LTS?{% endcomment %}

{% if include.major_version.release_date != "N/A" %}
{% if include.major_version.asst_supp_exp_date == "N/A" %}
{% assign skippable = true %}
{% elsif include.major_version.initial_lts_patch != "N/A" %}
{% assign lts = true %}
{% endif %}
{% endif %}

{% if DEBUG == true %}
include.major_version: {{ include.major_version }}<br />
page.major_version: {{ page.major_version }}<br />
branched: {{ branched }}<br />
will_never_have_lts: {{ will_never_have_lts }}<br />
lts: {{ lts }}<br />
skippable: {{ skippable }}<br />
no_highlights: {{ no_highlights }}<br />
<br />
{% endif %}

{% 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.dedicated }} and CockroachDB {{ site.data.products.core }} clusters but is required for CockroachDB {{ site.data.products.serverless }}.
{% 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).
{% endif %}

Refer to [Major release types]({% link releases/release-support-policy.md %}#support-types) before installing or upgrading for release timing and support details.{% if no_highlights == false %} To learn what’s new in this release, refer to its [Feature Highlights](#feature-highlights).{% endif %}

On this page, you can read about changes and find downloads for all production and testing releases of CockroachDB {{ page.major_version }}{% if lts == true %}&nbsp;[(LTS)]({% link releases/release-support-policy.md %}#support-phases){% endif %}

{% comment %}v1.0 has no #v1-0-0 anchor, and before GA other releases also do not.{% endcomment %}
- For key feature enhancements in {{ page.major_version }} and other upgrade considerations, refer to the notes for {% if include.major_version.release_date != 'N/A' and 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 %}).
- {{ install_sentence | strip_newlines }}

{% comment %}The strip_newlines is needed here because otherwise Jekyll inserts <p> tags around the install and ugrade links{% endcomment %}
{% comment %}The strip_newlines is needed here because otherwise Jekyll inserts <p> tags around the install and upgrade links{% endcomment %}
Get future release notes emailed to you:

{% include_cached marketo.html formId=1083 %}
Loading

0 comments on commit 9f95339

Please sign in to comment.