fix(docs): separate main docs from versioned releases - #488
Conversation
✅ Deploy Preview for uds-product-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Greptile SummaryThe PR separates main-branch documentation from pinned releases while retaining the current release in version-aware navigation.
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains. Important Files Changed
Reviews (4): Last reviewed commit: "fix(docs): make latest release navigatio..." | Re-trigger Greptile |
mjnagel
left a comment
There was a problem hiding this comment.
Wondering if there should be a change to how the version banner is managed?
I would expect it to not show up when I'm on the latest release, and then probably also when on older releases would expect to be linked to the latest release (1.10 rather than main). Potentially also could/should have a banner for main also to note that it's unreleased docs/code?
I tend to like how Velero does this:
maindocs banner (notes in development): https://velero.io/docs/main/- latest release (no banner): https://velero.io/docs/v1.18/
- older release banner (links to latest release): https://velero.io/docs/v1.17/
Two related things:
- I think
latestshould be released version, notmain - The default version should also be the latest released version
|
Updated this PR to include the fixes for CORE-665 and CORE-668. This covers separating the latest and versioned docs, and keeping users on the same page when switching between versions, as well as some additional enhancements around the redirects to avoid white page flashes. |
briantwatson
left a comment
There was a problem hiding this comment.
Finding the e2e tests failing I believe due to new core release.
I was doing some testing/changes locally to familiarize myself with docs dev and thought I'd share what I had working in PR to this branch here: #490. Feel free to use/discard as you wish.
Also made changes there in 404 docs home link behavior. Seeing the 'white flash' of full reload there. My preference would be to maintain the version a user is on rather root, but that's more of a nit.
0b41480
Description
Fixes CORE-665 and CORE-668.
This updates the docs site to separate unreleased
maindocumentation from versioned releases and preserve navigation when switching between product versions.Changes
Latest (main).main.archiveCount: 0.backup-and-restorecorrectly.No changes are required in
uds-coreoruds-cli.Validation
npm testnpm run test:unit