Skip to content

Reorganize and simplify releases nav#23122

Open
jhlodin wants to merge 2 commits intomainfrom
jl/doc-16117-manual
Open

Reorganize and simplify releases nav#23122
jhlodin wants to merge 2 commits intomainfrom
jl/doc-16117-manual

Conversation

@jhlodin
Copy link
Contributor

@jhlodin jhlodin commented Mar 19, 2026

https://cockroachlabs.atlassian.net/browse/DOC-16117

  • Remove "Staged release process" page which is an outdated artifact of the release policy change
  • Move "Technical advisories" down to reference section which is more appropriate than releases
  • Rework "Unsupported versions" into a "downloads archive" which is more accurate for the page's contents, and aligns with the long-term plan of removing archived CRDB binary downloads off of docs altogether
  • Move "Archived documentation" down to reference section which is more appropriate than releases
  • Add redirects as needed

@netlify
Copy link

netlify bot commented Mar 19, 2026

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 49a3851
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/69bc5869b4b5f50008b12374

@netlify
Copy link

netlify bot commented Mar 19, 2026

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 49a3851
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/69bc58694e8f3d0008d2a29c

@github-actions
Copy link

Files changed:

  • src/current/_data/redirects.yml
  • src/current/_includes/releases/staged-release-policy.md:
  • src/current/_includes/sidebar-all-releases.json
  • src/current/_includes/sidebar-releases.json
  • src/current/_includes/v23.1/sidebar-data/reference.json
  • src/current/_includes/v23.2/sidebar-data/reference.json
  • src/current/_includes/v24.1/sidebar-data/reference.json
  • src/current/_includes/v24.2/sidebar-data/reference.json
  • src/current/_includes/v24.3/sidebar-data/reference.json
  • src/current/_includes/v25.1/sidebar-data/reference.json
  • src/current/_includes/v25.2/sidebar-data/reference.json
  • src/current/_includes/v25.3/sidebar-data/reference.json
  • src/current/_includes/v25.4/sidebar-data/reference.json
  • src/current/_includes/v26.1/sidebar-data/reference.json
  • src/current/_includes/v26.2/sidebar-data/reference.json
  • src/current/releases/downloads-archive.md
  • src/current/releases/index.md
  • src/current/releases/staged-release-process.md

@netlify
Copy link

netlify bot commented Mar 19, 2026

Netlify Preview

Name Link
🔨 Latest commit 53ab009
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/69bc57e89046260008f32436
😎 Deploy Preview https://deploy-preview-23122--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@jhlodin jhlodin requested a review from taroface March 19, 2026 20:24
@netlify
Copy link

netlify bot commented Mar 19, 2026

Netlify Preview

Name Link
🔨 Latest commit 49a3851
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/69bc5869dfb5bc0008ca5a73
😎 Deploy Preview https://deploy-preview-23122--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

@taroface taroface left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple minor suggestions. However, I'm not sure I agree with

Move "Technical advisories" down to reference section which is more appropriate than releases

The TAs are release-specific contingencies that someone contemplating an upgrade may want to see. They also don't feel consistent with general "Reference" material. The way that they're presented feels reminiscent of a changelog, since this is a running list of notices. I suggest leaving this under Releases for now.

---
title: Unsupported Versions
summary: Versions of CockroachDB that are no longer supported
title: CockroachDB downloads archive
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Titles have to use title case:

Suggested change
title: CockroachDB downloads archive
title: CockroachDB Downloads Archive

| v26.2 | Regular | 2026 Q2 |

## Unsupported versions
## CockroachDB downloads archive
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something like this feels more intuitive IMO - "downloads archive" suggests to me that all releases are found here.

Suggested change
## CockroachDB downloads archive
## Archived releases

## CockroachDB downloads archive

A full archive of CockroachDB major versions that are no longer supported is available on the [Unsupported Versions]({% link releases/unsupported-versions.md %}) page.
A full archive of CockroachDB major versions that are no longer supported is available on the [CockroachDB downloads archive]({% link releases/downloads-archive.md %}) page.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A full archive of CockroachDB major versions that are no longer supported is available on the [CockroachDB downloads archive]({% link releases/downloads-archive.md %}) page.
To access CockroachDB versions that are no longer supported, refer to [CockroachDB Downloads Archive]({% link releases/downloads-archive.md %}).

@jhlodin
Copy link
Contributor Author

jhlodin commented Mar 20, 2026

A couple minor suggestions. However, I'm not sure I agree with

Move "Technical advisories" down to reference section which is more appropriate than releases

The TAs are release-specific contingencies that someone contemplating an upgrade may want to see. They also don't feel consistent with general "Reference" material. The way that they're presented feels reminiscent of a changelog, since this is a running list of notices. I suggest leaving this under Releases for now.

@taroface I think the context in which someone wants to know about a technical advisory is when the advisory is posted, rather than at a time when they're considering upgrading more broadly, which is why I don't generally think of TAs as release material. My proposal here is that it's a low-risk opportunity to further simplify the releases nav, which is already dense with the variety of release notes captured.

Case in point, Starburst docs bundle technical advisories in with other high-level security information despite having advisories associated with affected and mitigated product versions.

Let me know what you think, that's my argument but if you disagree I'm comfortable reverting this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants