[DOC-10431] Further LTS improvements #18661

mdlinville · 2024-06-17T23:44:47Z

[DOC-10431] Further LTS improvements

Update the logic on the Releases index to get the LTS status from site.data.versions instead of site.data.releases
Update the version switcher to show LTS status both for the currently-viewed page version above the drop-down and in the list of versions in the drop-down
Modify the LTS Maintenance admonition from a red warning to a purple note.
Fix some LTS logic issues including off-by-one errors on LTS maintenance and assistance dates
In the Docker tab, hide the Notes column for all versions except for v23.1 and v22.2.
Fix a display bug each in the Source and Docker tabs

Also added some debug messages and the ability to enable or disable debug in the Releases index and the version switcher. The debug info shows in the page source as HTML comments.

Previews

Description	URL	Description
Versioned page, not LTS, dev version	https://deploy-preview-18661--cockroachdb-docs.netlify.app/docs/v24.2/diagnostics-reporting (for example)	If the page exists for an LTS version, the entry for that version shows as LTS.
Versioned page, not LTS, stable version, in Assistance Support	https://deploy-preview-18661--cockroachdb-docs.netlify.app/docs/v24.1/diagnostics-reporting (for example)	If the page exists for an LTS version, the entry for that version shows as LTS. Red admonition.
Versioned page, LTS, in LTS Assistance Support	https://deploy-preview-18661--cockroachdb-docs.netlify.app/docs/v23.2/diagnostics-reporting (for example)	If the page exists for an LTS version, the entry for that version shows as LTS. Red admonition.
Versioned page, LTS, EOL	https://deploy-preview-18661--cockroachdb-docs.netlify.app/docs/v23.1/diagnostics-reporting (for example)	If the page exists for v23.1 and another version, v23.1 will be labeled as LTS and other entries do not. Red admonition.
Unversioned page (Release index)	https://deploy-preview-18661--cockroachdb-docs.netlify.app/docs/releases/.	LTS releases have (LTS) with a link to the Release Support Policy.
Unversioned page (Homepage)	https://deploy-preview-18661--cockroachdb-docs.netlify.app/docs/	Unchanged by this PR.

To test the purple admonition for the terminal maintenance phase, you can set the date to 2024-11-13 and check a 23.1 version of a page.

github-actions · 2024-06-17T23:45:08Z

Files changed:

src/current/_data/alerts.yml
src/current/_data/releases.yml
src/current/_includes/corestyle.scss
src/current/_includes/unsupported-version.md
src/current/_includes/version-switcher.html:

Warning: include not used in any version-switcher.html file or include

src/current/releases/index.md

netlify · 2024-06-17T23:45:22Z

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name	Link
🔨 Latest commit	`5eaf710`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/66ad641ecf611a0008e2699c

netlify · 2024-06-17T23:45:22Z

✅ Deploy Preview for cockroachdb-api-docs canceled.

Name	Link
🔨 Latest commit	`5eaf710`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-api-docs/deploys/66ad641e1d61f900080a1cc0

netlify · 2024-06-17T23:50:20Z

✅ Netlify Preview

Name	Link
🔨 Latest commit	`5eaf710`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-docs/deploys/66ad641e37083f000890db29
😎 Deploy Preview	https://deploy-preview-18661--cockroachdb-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

ebembi-crdb

LGTM!
Nothing seems breaking, have we tested it?

mdlinville · 2024-06-19T00:32:01Z

LGTM! Nothing seems breaking, have we tested it?

Yes, I have tested it during implementation, but I'm hoping others will too. Some suggestions:

Validate that the Releases index still correctly shows LTS details now that it is looking to versions.csv rather than release.yml.
Validate that the version switcher correctly shows LTS status on versioned LTS pages.
Validate that the 23.1 LTS admonition now shows as a green tip instead of a red warning.
Validate that this doesn't break the functionality that was just rolled out in [DOC-10557] Fix LTS date logic bug and 23.1 TOC #18667 (23.1 should show the LTS admonition on all pages, not just the What's New page).

mikeCRL

On the Releases page, all releases in the 23.2 table have "(LTS)" back through the first alpha.
The dropdown shows (LTS) next to 24.1 and 24.2 when each is the selected version. I believe that is incorrect.
I am seeing a red warning when viewing 24.1 and 23.2 pages (where the text correctly shows that maintenance support has ended but assistance is still active, per the 'today' date in the PR—LTS assistance in the case of 23.2). I believe these should now be purple?
What case should be green, if any? How can I test that?

src/current/_includes/unsupported-version.md

mdlinville · 2024-07-24T00:33:07Z

On the Releases page, all releases in the 23.2 table have "(LTS)" back through the first alpha.

Should be fixed.

The dropdown shows (LTS) next to 24.1 and 24.2 when each is the selected version. I believe that is incorrect.

Should be fixed.

I am seeing a red warning when viewing 24.1 and 23.2 pages (where the text correctly shows that maintenance support has ended but assistance is still active, per the 'today' date in the PR—LTS assistance in the case of 23.2). I believe these should now be purple?

Nope, the terminal phase is still red, as per Shannon.

What case should be green, if any? How can I test that?

None should be green -- I mention this right below the screenshot showing green.

mdlinville · 2024-07-25T20:44:55Z

The "Everything showing as LTS" bug should actually be fixed now, in this PR.

src/current/_includes/unsupported-version.md

src/current/releases/index.md

mikeCRL

Bug in the Source tab view. Not sure if I missed this on the previous review. https://deploy-preview-18661--cockroachdb-docs.netlify.app/docs/releases/?filters=source
Docker tab issues https://deploy-preview-18661--cockroachdb-docs.netlify.app/docs/releases/?filters=docker ; generally the Notes column needs to be rechecked throughout.
- For major versions with an LTS, note that LTS is displayed through the first non-experimental version.
- For v23.1 Production:
  - Row with "Available only for select CockroachDB Cloud clusters" is missing a fourth cell.
  - LTS is listed back through 23.1.13 instead of 23.1.12
- For Testing releases, can we leave out the GA/Experimental mentions? Perhaps leave it blank? Better to leave "Testing" be the only characterization than to use "GA" there, which is defined as production ready.

mdlinville · 2024-07-31T21:11:48Z

Bug in the Source tab view. Not sure if I missed this on the previous review. https://deploy-preview-18661--cockroachdb-docs.netlify.app/docs/releases/?filters=source

There was some debug output present, now fixed.

Docker tab issues https://deploy-preview-18661--cockroachdb-docs.netlify.app/docs/releases/?filters=docker ; generally the Notes column needs to be rechecked throughout.

It's sad, but we need to redo the looping logic from the Linux tab in the Mac tab. Fixed. Also moved the "LTS" over to the first column to align with the Linux tab.

The reason the Notes column is there is because in v22.2 and v23.1, the contents of all rows are not the same. I will need to conditionalize the # of columns based on the version number to remove them. It's do-able, just adds a bit more complexity to the upkeep of the page.

Let me summarize what I did to fix the Docker tab:

Conditionalize the intro para to show only before the Production section, not for testing releases.
In the intro text, for versions where all Docker images are multi-platform, state that. For mixed versions, retain the explanation about Intel vs multi-platform. For pre-ARM versions,
Show the Notes column only for versions with both GA and pre-GA ARM support (v22.2 and v23.1)
In the Notes column, don't print Intel because it's implied and also covered in the Docker intro.

For major versions with an LTS, note that LTS is displayed through the first non-experimental version.

Fixed. I needed to re-initialize some variables in the Docker loop.

For v23.1 Production:

Row with "Available only for select CockroachDB Cloud clusters" is missing a fourth cell.

It's actually not, it's a colspan. I tested locally after designating 23.1.24 as Cloud-only:

* LTS is listed back through 23.1.13 instead of 23.1.12

I can't reproduce this. Verified in versions.csv that 23.1.11 is listed as the last GA patch and 23.1.12 as the first LTS patch, and here is how it looks with a local build:

For Testing releases, can we leave out the GA/Experimental mentions? Perhaps leave it blank? Better to leave "Testing" be the only characterization than to use "GA" there, which is defined as production ready.

I've minimized it, but I am pretty sure I should not remove Experimental from the versions for which ARM actually was Experimental. It's only still listed in v22.2 and v23.1, which had a mix. We need to leave that in there so that customers don't think ARM was supported prior to v22.2.17, v23.1.12, or v23.2.0, including the testing releases leading up to v23.2.0.

mikeCRL

LGTM

mdlinville requested a review from mikeCRL June 17, 2024 23:45

mdlinville requested a review from ebembi-crdb June 17, 2024 23:45

ebembi-crdb reviewed Jun 18, 2024

View reviewed changes

mdlinville requested a review from ebembi-crdb June 21, 2024 21:58

mikeCRL force-pushed the DOC-10431 branch from 6ad35a1 to 4354052 Compare June 25, 2024 04:05

mdlinville force-pushed the DOC-10431 branch 2 times, most recently from 3cea7ae to b217269 Compare July 2, 2024 23:19

mdlinville force-pushed the DOC-10431 branch from b217269 to 3d47ade Compare July 2, 2024 23:27

mikeCRL requested changes Jul 19, 2024

View reviewed changes

src/current/_includes/unsupported-version.md Show resolved Hide resolved

mdlinville commented Jul 23, 2024

View reviewed changes

src/current/_includes/unsupported-version.md Show resolved Hide resolved

mdlinville force-pushed the DOC-10431 branch from b29ab18 to ea7691f Compare July 24, 2024 00:30

mdlinville force-pushed the DOC-10431 branch from dfd249b to 552090a Compare July 25, 2024 20:43

mdlinville requested a review from mikeCRL July 25, 2024 20:44

mdlinville commented Jul 25, 2024

View reviewed changes

src/current/_includes/unsupported-version.md Outdated Show resolved Hide resolved

src/current/releases/index.md Show resolved Hide resolved

mikeCRL reviewed Jul 31, 2024

View reviewed changes

mdlinville requested a review from mikeCRL July 31, 2024 21:12

mdlinville mentioned this pull request Aug 1, 2024

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

Merged

mikeCRL approved these changes Aug 1, 2024

View reviewed changes

mdlinville added 4 commits August 2, 2024 15:45

[DOC-10431] Update releases index to look to versions for LTS status

2294dd9

Display LTS status in version switcher

a59a4f2

Use the purple version admonition for maintenance phases

767642e

Mike's feedback about the admonition text

8fbb2cf

mdlinville added 3 commits August 2, 2024 15:45

Fix every version showing as LTS

82d35d7

Mike's feedback

9cc0749

Attempt to fix display issues on Docker tab

d53ba41

mdlinville force-pushed the DOC-10431 branch 2 times, most recently from e87dc47 to d53ba41 Compare August 2, 2024 22:53

Remove newly-added lts fields from releases.yml

5eaf710

mdlinville enabled auto-merge (squash) August 2, 2024 22:57

mdlinville merged commit a80267f into main Aug 2, 2024
7 checks passed

mdlinville deleted the DOC-10431 branch August 2, 2024 23:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOC-10431] Further LTS improvements #18661

[DOC-10431] Further LTS improvements #18661

mdlinville commented Jun 17, 2024 •

edited

Loading

github-actions bot commented Jun 17, 2024 •

edited

Loading

netlify bot commented Jun 17, 2024 •

edited

Loading

netlify bot commented Jun 17, 2024 •

edited

Loading

netlify bot commented Jun 17, 2024 •

edited

Loading

ebembi-crdb left a comment

mdlinville commented Jun 19, 2024

mikeCRL left a comment

mdlinville commented Jul 24, 2024

mdlinville commented Jul 25, 2024

mikeCRL left a comment

mdlinville commented Jul 31, 2024 •

edited

Loading

mikeCRL left a comment

[DOC-10431] Further LTS improvements #18661

[DOC-10431] Further LTS improvements #18661

Conversation

mdlinville commented Jun 17, 2024 • edited Loading

Previews

github-actions bot commented Jun 17, 2024 • edited Loading

Files changed:

netlify bot commented Jun 17, 2024 • edited Loading

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

netlify bot commented Jun 17, 2024 • edited Loading

✅ Deploy Preview for cockroachdb-api-docs canceled.

netlify bot commented Jun 17, 2024 • edited Loading

✅ Netlify Preview

ebembi-crdb left a comment

Choose a reason for hiding this comment

mdlinville commented Jun 19, 2024

mikeCRL left a comment

Choose a reason for hiding this comment

mdlinville commented Jul 24, 2024

mdlinville commented Jul 25, 2024

mikeCRL left a comment

Choose a reason for hiding this comment

mdlinville commented Jul 31, 2024 • edited Loading

mikeCRL left a comment

Choose a reason for hiding this comment

mdlinville commented Jun 17, 2024 •

edited

Loading

github-actions bot commented Jun 17, 2024 •

edited

Loading

netlify bot commented Jun 17, 2024 •

edited

Loading

netlify bot commented Jun 17, 2024 •

edited

Loading

netlify bot commented Jun 17, 2024 •

edited

Loading

mdlinville commented Jul 31, 2024 •

edited

Loading