-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
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
chore(plugin-docs): remove legacy versioned prefix on doc ids and sidebar names in versioned sidebars #9310
Merged
Conversation
This file contains 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
slorber
added
the
pr: breaking change
Existing sites may not build successfully in the new version. Description contains more details.
label
Sep 15, 2023
slorber
changed the title
chore(plugin-docs): remove legacy versioned doc ids and sidebar names in versioned sidebars
chore(plugin-docs): remove legacy versioned prefix on doc ids and sidebar names in versioned sidebars
Sep 15, 2023
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
Size Change: 0 B Total Size: 1.11 MB ℹ️ View Unchanged
|
This was referenced Oct 19, 2023
3 tasks
ryankert01
added a commit
to ryankert01/yunikorn-site
that referenced
this pull request
Apr 9, 2024
This was referenced Jun 16, 2024
This was referenced Jun 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
CLA Signed
Signed Facebook CLA
pr: breaking change
Existing sites may not build successfully in the new version. Description contains more details.
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.
Breaking change
Docusaurus v3 does not support anymore the legacy versioned sidebar files that add a versioned prefix to all doc ids and sidebar names.
For example, this versioned sidebar file is now invalid.
The fix is simple: remove the
version-v2.0.0/
prefix everywhereMotivation
Fix #6018
Very early Docusaurus v2 versions used to create versioned sidebar files with useless "versioned prefixes.
Example from an older version of the Relay website: https://github.com/facebook/relay/blob/main/website/versioned_sidebars/version-v2.0.0-sidebars.json
We stopped adding that prefix a long time ago in Docusaurus v2, but still kept supporting these version prefixes, at the cost of increased complexity.
In Docusaurus v3, we remove this historical retrocompatible support and clean the Docusaurus codebase from that extra complexity.
If your oldest sidebar files still use these version prefixes, please remove them. The example above should be refactored to:
Test Plan
CI
Test links
Deploy preview: https://deploy-preview-9310--docusaurus-2.netlify.app/