feat: add multi-version docs support#237
Open
schacherle wants to merge 1 commit into
Open
Conversation
Enable native versioning for a specific version of Shipwright Build Add version dropdown to navbar Fixes shipwright-io#136 Signed-off-by: Ernst Schacherl <git+shipwright@schacherl.dev>
openshift-ci
Bot
added
the
kind/feature
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
pull-request-size
Bot
added
the
size/XXL
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Enables Docusaurus's native versioned docs so users can view documentation for a specific released version of Shipwright Build, instead of only ever seeing the latest unreleased state.
0.20, matching the current latest Build release line (v0.20.x)./docs/path serves the latest released version (0.20), and the unversioneddocs/folder (trackingmain, i.e. unreleased work) serves at/docs/next/. This matches the convention used by Jest, React Native, and Docusaurus's own docs site.Note on sequencing vs. SHIP-0041
I'm aware of the (still
provisional, unimplemented) SHIP-0041 docs restructure proposal. Cutting a version now means this first0.20snapshot stays in the currentbuild/getting-started/reflayout even if/when that restructure lands later — subsequent versions cut after a restructure would just pick up the new layout. This is the same tradeoff every project with versioned docs eventually hits (older versions naturally look structurally different from current docs), so I don't think it should block this from landing. Happy to hold off if maintainers feel otherwise.Related Issue
Fixes #136
Type of PR
/kind feature
Submitter Checklist
Release Notes