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

Optimising Sidenav load time #19311

Merged
merged 5 commits into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions src/current/_data/supported_versions.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
major_version,release_date,maint_supp_exp_date,asst_supp_exp_date,last_ga_patch,initial_lts_patch,initial_lts_release_date,lts_maint_supp_exp_date,lts_asst_supp_exp_date,previous_version,crdb_branch_name
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,24.1.5,24.1.6,2024-10-21,2025-10-21,2026-10-21,v23.2,release-24.1
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
v24.3,2024-11-18,2025-11-18,2026-05-18,N/A,N/A,N/A,N/A,N/A,v24.2,release-24.3
v25.1,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,v24.2,release-24.3
14 changes: 14 additions & 0 deletions src/current/_data/unsupported_versions.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
major_version,release_date,maint_supp_exp_date,asst_supp_exp_date,last_ga_patch,initial_lts_patch,initial_lts_release_date,lts_maint_supp_exp_date,lts_asst_supp_exp_date,previous_version,crdb_branch_name
v1.0,2017-05-10,2018-05-10,2018-11-10,N/A,N/A,N/A,N/A,N/A,N/A,release-1.0
v1.1,2017-10-12,2018-10-12,2019-04-12,N/A,N/A,N/A,N/A,N/A,v1.0,release-1.1
v2.0,2018-04-04,2019-04-04,2019-10-04,N/A,N/A,N/A,N/A,N/A,v1.1,release-2.0
v2.1,2018-10-30,2019-10-30,2020-04-30,N/A,N/A,N/A,N/A,N/A,v2.0,release-2.1
v19.1,2019-04-30,2020-04-30,2020-10-30,N/A,N/A,N/A,N/A,N/A,v2.1,release-19.1
v19.2,2019-11-12,2020-11-12,2021-05-12,N/A,N/A,N/A,N/A,N/A,v19.1,release-19.2
v20.1,2020-05-12,2021-05-12,2021-11-12,N/A,N/A,N/A,N/A,N/A,v19.2,release-20.1
v20.2,2020-11-10,2021-11-10,2022-05-10,N/A,N/A,N/A,N/A,N/A,v20.1,release-20.2
v21.1,2021-05-18,2022-05-18,2022-11-18,N/A,N/A,N/A,N/A,N/A,v20.2,release-21.1
v21.2,2021-11-16,2022-11-16,2023-05-16,N/A,N/A,N/A,N/A,N/A,v21.1,release-21.2
v22.1,2022-05-24,2023-05-24,2023-11-24,N/A,N/A,N/A,N/A,N/A,v21.2,release-22.1
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
6 changes: 6 additions & 0 deletions src/current/_includes/sidebar-all-releases.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,10 @@
"urls": [
"/releases/kubernetes-operator.html"
]
},
{
"title": "Unsupported versions",
"urls": [
"/releases/unsupported-versions.html"
]
}
7 changes: 7 additions & 0 deletions src/current/_includes/sidebar-releases.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,11 @@
,"{{ x.url }}"
{% endfor %}
]
},
{
"title": "Unsupported versions",
"urls": [
"/releases/unsupported-versions.html"
]
}

2 changes: 1 addition & 1 deletion src/current/advisories/a48860.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The public issue is tracked as [#48860](https://github.com/cockroachdb/cockroach

There is no mitigation possible without an upgrade. Cockroach Labs recommends that customers upgrade to the latest release of [v19.1](https://www.cockroachlabs.com/docs/v19.1/upgrade-cockroach-version), [v19.2](https://www.cockroachlabs.com/docs/v19.2/upgrade-cockroach-version), or [v20.1](https://www.cockroachlabs.com/docs/v20.1/upgrade-cockroach-version.html), all of which are currently under [Maintenance Support](https://www.cockroachlabs.com/docs/releases/release-support-policy#support-cycle).

Because CockroachDB v2.1 will reach [End of Life](https://www.cockroachlabs.com/docs/releases/release-support-policy#support-cycle) on July 1, 2020, no new maintenance release for v2.1 will be issued containing a fix for this bug. Affected deployments running v2.1 should be upgraded to at least the latest release of [v19.1](https://www.cockroachlabs.com/docs/v19.1/upgrade-cockroach-version).
Because CockroachDB v2.1 will reach [unsupported](https://www.cockroachlabs.com/docs/releases/release-support-policy#support-cycle) on July 1, 2020, no new maintenance release for v2.1 will be issued containing a fix for this bug. Affected deployments running v2.1 should be upgraded to at least the latest release of [v19.1](https://www.cockroachlabs.com/docs/v19.1/upgrade-cockroach-version).

## Impact

Expand Down
2 changes: 1 addition & 1 deletion src/current/cockroachcloud/alerts-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The **Alerts** page is applicable for CockroachDB {{ site.data.products.advanced

- A cluster is scheduled for an automatic [patch version upgrade]({% link cockroachcloud/upgrade-policy.md %}#patch-version-upgrades) and again after the upgrade is complete.
- When a cluster is scheduled for [maintenance]({% link cockroachcloud/advanced-cluster-management.md %}#set-a-maintenance-window) that could temporarily impact the cluster's performance.
- When a cluster's CockroachDB version is nearing [end of life]({% link releases/release-support-policy.md %}#support-phases) and must be upgraded to maintain support.
- When a cluster's CockroachDB version is nearing [unsupported]({% link releases/release-support-policy.md %}#support-phases) and must be upgraded to maintain support.

### CMEK

Expand Down
10 changes: 3 additions & 7 deletions src/current/js/customscripts.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,10 @@ function renderTOC() {
});

// Set class on top level elements
if(document.getElementById('toc-right') && (document.getElementById('toc-right').children.length > 0)){
var list = document.getElementById('toc-right').children[0].childNodes;
for (let li of list) {
li.classList.add('toc-li-top');
}
}
var list = document.querySelectorAll('#toc-right > ul > li');
list.forEach(li => li.classList.add('toc-li-top'));
}

document.addEventListener('DOMContentLoaded', renderTOC);
var $versionSwitcher, versionSwitcherBottom = Infinity;

const cockroachDomains = [
Expand Down
9 changes: 7 additions & 2 deletions src/current/releases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: CockroachDB Releases
summary: Information about CockroachDB releases with an index of available releases and their release notes and binaries.
toc: true
# toc_not_nested: true
docs_area: releases
---

Expand Down Expand Up @@ -116,7 +117,7 @@ As of 2024, CockroachDB is released under a staged delivery process. New release
| [v24.2](#v24-2) | Innovation | 2024-08-12 |
| [v24.1](#v24-1) | Regular | 2024-05-20 |
| [v23.2](#v23-2) | Regular | 2024-02-05 |
| [v23.1](#v23-1) | Regular | 2023-05-15 |
| [v23.1](https://www.cockroachlabs.com/docs/releases/unsupported-versions#v23-1) | Regular | 2023-05-15 |

### Upcoming releases

Expand All @@ -139,7 +140,7 @@ The following releases and their descriptions represent proposed plans that are
{% assign released_versions = site.data.releases | map: "major_version" | uniq | reverse %}
{% comment %} Fetch the list of the major versions of all releases that currently exist {% endcomment %}

{% assign versions = site.data.versions | where_exp: "versions", "released_versions contains versions.major_version" | sort: "release_date" | reverse %}
{% assign versions = site.data.supported_versions | where_exp: "versions", "released_versions contains versions.major_version" | sort: "release_date" | reverse %}
{% comment %} Fetch all major versions (e.g., v21.2), sorted in reverse chronological order. {% endcomment %}

{% assign latest_hotfix = site.data.releases | where_exp: "latest_hotfix", "latest_hotfix.major_version == site.versions['stable']" | where_exp: "latest_hotfix", "latest_hotfix.withdrawn != true" | sort: "release_date" | reverse | first %}
Expand Down Expand Up @@ -602,3 +603,7 @@ All binaries available on this page released on or after the day 24.3.0 is relea
All binaries available on this page released prior to the release date of 24.3.0 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 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
[Here]({% link releases/unsupported-versions.md %}) are the versions of CockroachDB that are no longer supported

10 changes: 5 additions & 5 deletions src/current/releases/release-support-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ There are two major release types: [Regular and Innovation releases]({% link rel
- Patch releases for the purpose of resolving bugs or other errors may no longer be made to the major release.
- Cockroach Labs may direct customers to workarounds or other fixes applicable to the reported case.
- Cockroach Labs may direct customers to [upgrade](https://www.cockroachlabs.com/docs/stable/upgrade-cockroach-version) to a later version of CockroachDB to resolve or further troubleshoot an issue.
- **End of Life (EOL)**: The day that a major version’s final support period ends is its EOL date. After a version reaches EOL, Cockroach Labs provides no further support for the release.
- A Regular release reaches EOL at the Assistance Support phase's end date.
- An Innovation releases reaches EOL at the Maintenance Support phase's end date.
- **Unsupported**: The day that a major version’s final support period ends is its unsupported date. After a version reaches end of life, Cockroach Labs provides no further support for the release.
- A Regular release reaches unsupported at the Assistance Support phase's end date.
- An Innovation releases reaches unsupported at the Maintenance Support phase's end date.

## Support Types

### Regular releases

Initially, a Regular release series has GA Support. After the series demonstrates a continuously high level of stability and performance, new patch releases are designated as LTS releases, which have an extended support window for each [support phase](#support-phases): Maintenance Support, Assistance Support, and EOL (End of Life).
Initially, a Regular release series has GA Support. After the series demonstrates a continuously high level of stability and performance, new patch releases are designated as LTS releases, which have an extended support window for each [support phase](#support-phases): Maintenance Support, Assistance Support, and Unsupported versions.

- **GA Support**: The default support type for production releases, starting with the initial production release of a major version, followed by each subsequent patch release before LTS releases begin for that major version.
- **Maintenance support ends**:
Expand Down Expand Up @@ -169,7 +169,7 @@ Innovation releases are not eligible for Assistance Support, and reach EOL at th
<sup id="lts-tbd">&#42;&nbsp;&nbsp;: This major version will receive LTS patch releases, which will be listed on an additional row, upon their availability.</sup><br />
<sup id="skippable">&#42;&#42;&nbsp;&nbsp;: 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 />

## End-of-life (EOL) versions
## Unsupported versions

The following versions of CockroachDB are no longer supported.

Expand Down
Loading
Loading