Skip to content
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

[DOC-10687][DOC-10733] Self-hosted tooling and task updates for innovation releases #18778

Merged
merged 102 commits into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
102 commits
Select commit Hold shift + click to select a range
2017670
Trivial commit to set up feature branch
mdlinville Jul 16, 2024
30708f3
Merge branch 'main' into DOC-10686_innovation
mdlinville Jul 17, 2024
e3381a1
Merge branch 'main' into DOC-10686_innovation
mdlinville Jul 18, 2024
18204a8
Merge branch 'main' into DOC-10686_innovation
mdlinville Jul 23, 2024
fa42438
Merge branch 'main' into DOC-10686_innovation
mdlinville Jul 24, 2024
42b02c3
Merge branch 'main' into DOC-10686_innovation
mdlinville Jul 31, 2024
f3d1e73
Merge branch 'main' into DOC-10686_innovation
mdlinville Jul 31, 2024
1b15b2b
Merge branch 'main' into DOC-10686_innovation
mdlinville Aug 2, 2024
fcd9463
Merge branch 'main' into DOC-10686_innovation
mdlinville Aug 5, 2024
cce3fe6
[DOC-10687] Tooling for innovation releases
mdlinville Jul 19, 2024
eaf7f88
Merge branch 'main' into DOC-10686_innovation
mikeCRL Aug 6, 2024
8f6a14d
Add support for innovation releases to release support policy page
mdlinville Aug 6, 2024
241f69c
Merge branch 'main' into DOC-10686_innovation
mdlinville Aug 7, 2024
3c6c657
Add support for Innovation Releases to What's New pages
mdlinville Aug 6, 2024
976508e
(1) In export-metrics.md, added preview note for Prometheus for Azure…
florence-crl Aug 5, 2024
0a30cab
Remove the sysbench benchmarking and docs release note (#18776)
kathancox Aug 5, 2024
d237730
MOLT Docker install and usage (#18784)
taroface Aug 5, 2024
43ff03e
MOLT 1.1.2 and 1.1.3 release updates (#18780)
taroface Aug 5, 2024
eca50ce
v24.1.3 publish binaries (#18787)
kathancox Aug 5, 2024
a8d91b6
In releases.yml, removed cloud attributes to show download links for …
florence-crl Aug 5, 2024
a8a27b5
Update the resolved message docs for more guidance on the configuring…
kathancox Aug 5, 2024
394b864
DOC-10555 Add network metrics to Essential Metrics (#18671)
florence-crl Aug 6, 2024
4fa8484
Copied cockroachdb-feature-availability.md from v24.1 to v24.2. (#18789)
florence-crl Aug 6, 2024
7e90f2c
Add existing limitations for changefeeds with column families (#18766)
kathancox Aug 6, 2024
7ac6479
Update the cdc technical overview for new changefeed work distributio…
kathancox Aug 6, 2024
f89ca1f
Add `schema_locked` storage parameter for changefeed performance impr…
kathancox Aug 6, 2024
3311519
Update the PCR KLs for performance numbers (#18793)
kathancox Aug 6, 2024
dfaf739
Merge remote-tracking branch 'origin/DOC-10686_innovation' into DOC-1…
mdlinville Aug 7, 2024
622f816
Merge remote-tracking branch 'origin/DOC-10686_innovation' into DOC-1…
mdlinville Aug 7, 2024
97da520
Update Releases index
mikeCRL Aug 7, 2024
2d1d77d
Update Release Support Policy and fix anchor links
mikeCRL Aug 7, 2024
382a184
Initial update to Upgrade policy
mikeCRL Aug 7, 2024
d765667
Fix Upgrade policy links
mikeCRL Aug 8, 2024
503897d
Various improvements across pages
mikeCRL Aug 8, 2024
bc4c666
Automate display of latest major and patch release on Releases index
mikeCRL Aug 8, 2024
38d58da
Fix anchor links, plus a couple minor edits
mikeCRL Aug 8, 2024
d7499ca
Minor grammar fix
mikeCRL Aug 8, 2024
59495f8
Add temporary v24.2 upgrade page to avoid broken links
mdlinville Aug 9, 2024
6396889
Copyedit upgrade policy
mdlinville Aug 9, 2024
712bb9f
Update v24.2 dummy file
mdlinville Aug 9, 2024
92e733d
Copyedits to Release Support Policy
mdlinville Aug 9, 2024
ec7fc72
Temporarily update stable version
mdlinville Aug 9, 2024
9542afb
Copyedits to Release index
mdlinville Aug 9, 2024
7fe2f83
More copyedit of release-support-policy, fix display bug
mdlinville Aug 9, 2024
d98a8ff
Update src/current/cockroachcloud/upgrade-policy.md
mdlinville Aug 9, 2024
116a4c4
Fix links
mdlinville Aug 9, 2024
9096042
[DOC-10687] Tooling for innovation releases
mdlinville Jul 19, 2024
85af1c7
Add support for innovation releases to release support policy page
mdlinville Aug 6, 2024
841cbeb
Add support for Innovation Releases to What's New pages
mdlinville Aug 6, 2024
6f02d4f
v24.2.0-rc.1 release notes (#18783)
kathancox Aug 7, 2024
b0c2191
Stored computed columns support FKs, with limits (#18792)
rmloveland Aug 8, 2024
ed1c166
Update COMMENT ON docs for types (#18761)
rmloveland Aug 8, 2024
0f50cdb
add VECTOR doc (#18791)
taroface Aug 8, 2024
ce7a538
document generic query plans (#18753)
taroface Aug 8, 2024
1ca91f8
molt fetch transformation rules (#18797)
taroface Aug 8, 2024
86874db
[DOC-10894] Update docs for selecting a cluster version (#18794)
mdlinville Aug 8, 2024
a8bd853
add missing known limitations (#18800)
taroface Aug 8, 2024
a1293b8
generic query plans are in preview (#18805)
taroface Aug 8, 2024
8afec4a
remove erroneous front-matter field (#18804)
taroface Aug 8, 2024
444690a
add VECTOR to feature availability page (#18806)
taroface Aug 8, 2024
fbb3596
add MOLT 1.1.4 release notes (#18807)
taroface Aug 8, 2024
c75fb4a
Merge remote-tracking branch 'origin/DOC-10687' into DOC-10687
mdlinville Aug 9, 2024
e4f8461
Add temporary v24.2.0 and v24.2 files
mdlinville Aug 9, 2024
9df1a76
Fix links and logic bugs
mdlinville Aug 9, 2024
092af24
Disable feature highlights for some old versions
mdlinville Aug 9, 2024
f9b18d3
Add temporary v2.4.0 YAML entry
mdlinville Aug 9, 2024
126693d
Add temporary anchor
mdlinville Aug 9, 2024
5550875
Improve code for determining skippability
mdlinville Aug 9, 2024
fbb8041
Remove highlights from v22.2 too
mdlinville Aug 9, 2024
222d952
Unset test variables
mdlinville Aug 9, 2024
29baa9f
Fix typo
mdlinville Aug 9, 2024
7d4e922
Fix another typo
mdlinville Aug 9, 2024
223cff8
Fix boolean mistake
mdlinville Aug 9, 2024
bd95cf6
Flip logic, silly mistake
mdlinville Aug 9, 2024
7d738f2
Disable debug
mdlinville Aug 9, 2024
64f2752
Try again to fix feature highlights in old versions
mdlinville Aug 9, 2024
a83c176
Typo
mdlinville Aug 9, 2024
bff3b26
Adjust logic for hiding feature highlights links
mdlinville Aug 9, 2024
1df2d8f
Disable debug output
mdlinville Aug 9, 2024
b890bd4
Update src/current/_includes/unsupported-version.md
mdlinville Aug 10, 2024
ccb8e8a
Merge remote-tracking branch 'origin/DOC-10686_innovation' into DOC-1…
mdlinville Aug 10, 2024
d19fec2
Test data
mdlinville Aug 10, 2024
d6a72c4
Merge remote-tracking branch 'origin/DOC-10686_innovation' into DOC-1…
mdlinville Aug 10, 2024
0d090b9
Set test entry as Production
mdlinville Aug 10, 2024
d5472b4
Update src/current/_includes/unsupported-version.md
mdlinville Aug 10, 2024
f4741d1
Typo 2025 should be 2024 when testing dates
mdlinville Aug 10, 2024
b5f910c
[DOC-10733] Add innovation support logic and instructions to self-hos…
mdlinville Aug 10, 2024
d603d1b
Add details about latest release to install and upgrade pages, use a …
mdlinville Aug 11, 2024
4fe1e9f
Fix links
mdlinville Aug 11, 2024
088a1c3
Merge remote-tracking branch 'origin/release-notes-v24.2.0' into DOC-…
mdlinville Aug 12, 2024
ce1836e
Merge remote-tracking branch 'origin/DOC-10686_innovation' into DOC-1…
mdlinville Aug 12, 2024
4e60279
Trivial commit to kick the build
mdlinville Aug 12, 2024
60df97d
redact LMS docs (#18808)
taroface Aug 12, 2024
4fffe39
Update src/current/releases/v24.2.md
mdlinville Aug 12, 2024
836d04e
Add cloud-first release notes for v24.2.0 (#18788)
rmloveland Aug 12, 2024
9adb3a6
Revert using latest-release-details.md on Releases index
mdlinville Aug 12, 2024
1c4a549
Sync versions.csv
mdlinville Aug 12, 2024
056d582
Merge remote-tracking branch 'origin/DOC-10687' into DOC-10687
mdlinville Aug 12, 2024
6c67921
Disable debug output
mdlinville Aug 12, 2024
f660ed8
Move paragraph, resolve anchor
mdlinville Aug 12, 2024
f995432
Merge remote-tracking branch 'origin/main' into DOC-10696_innovation
mdlinville Aug 12, 2024
2d5dc70
Merge remote-tracking branch 'origin/DOC-10696_innovation' into DOC-1…
mdlinville Aug 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/current/_data/redirects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -246,9 +246,6 @@
- 'learn-about-request-units.md'
versions: ['cockroachcloud']

- destination: molt/live-migration-service.md
sources: [':version/live-migration-service.md']

- destination: logging-overview.md
sources: ['debug-and-error-logs.md']
versions: ['v21.1']
Expand All @@ -274,6 +271,11 @@
- destination: molt/molt-fetch.md
sources: [':version/molt-fetch.md']

- destination: molt/molt-overview.md
sources:
- molt/live-migration-service.md
- :version/live-migration-service.md

- destination: molt/molt-verify.md
sources: [':version/molt-verify.md']

Expand Down
2 changes: 1 addition & 1 deletion src/current/_data/versions.csv
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ v22.2,2022-12-05,2023-12-05,2024-06-05,N/A,N/A,N/A,N/A,N/A,v22.1,release-22.2
v23.1,2023-05-15,2024-05-15,2024-11-15,23.1.11,23.1.12,2023-11-13,2024-11-13,2025-11-13,v22.2,release-23.1
v23.2,2024-02-05,2025-02-05,2025-08-05,23.2.6,23.2.7,2024-07-08,2025-07-08,2026-07-08,v23.1,release-23.2
v24.1,2024-05-20,2025-05-20,2025-11-20,N/A,N/A,N/A,N/A,N/A,v23.2,release-24.1
v24.2,2024-08-08,2025-08-08,N/A,N/A,N/A,N/A,N/A,N/A,v24.1,release-24.2
v24.2,2024-08-12,2025-02-12,N/A,N/A,N/A,N/A,N/A,N/A,v24.1,release-24.2
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 %}#innovation-releases) 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 %}#regular-releases).{% 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 %}
6 changes: 0 additions & 6 deletions src/current/_includes/molt/update-lms-version.md

This file was deleted.

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
Loading