fix: make docs/ the default version and sync v2.8.0 snapshot#369
Open
mesutoezdil wants to merge 1 commit into
Open
fix: make docs/ the default version and sync v2.8.0 snapshot#369mesutoezdil wants to merge 1 commit into
mesutoezdil wants to merge 1 commit into
Conversation
✅ Deploy Preview for project-hami ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
mesutoezdil
changed the title
mesutoezdil
changed the title
The website defaulted to the v2.8.0 versioned snapshot. All content improvements merged to docs/ since v2.8.0 were invisible on the live site. Contributors edited versioned_docs directly, causing ongoing divergence. - docusaurus.config.js: set lastVersion:'current' so docs/ is shown at /docs/ (labeled 'latest'); v2.8.0 moves to /docs/v2.8.0/ - versioned_docs/version-v2.8.0/: sync all 98 files with current docs/ After this merge, any PR to docs/ immediately appears on the live site. Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
mesutoezdil
force-pushed
the
fix/sync-v2.8.0-contributor-docs
branch
from
01e3233 to
e0e73d2
Compare
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: mesutoezdil, rootsongjc 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 |
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.
Problem
The website defaulted to the v2.8.0 versioned snapshot instead of the current docs. This caused two issues:
docs/were invisible on the live site despite being in master.versioned_docs/version-v2.8.0/directly to make changes visible, which caused the snapshot to diverge fromdocs/over time.Changes
Commit 1 - Sync 97 files in v2.8.0 snapshot:
Copies all files where
versioned_docs/version-v2.8.0/had fallen behinddocs/. Covers contributor guides, installation, userguide, developers, core-concepts, get-started, faq, troubleshooting, key-features, and releases.Commit 2 - Set
lastVersion: 'current'in docusaurus.config.js:Makes
docs/the default shown at/docs/. Versioned snapshots remain accessible at/docs/v2.8.0/,/docs/v2.7.0/, etc. The version dropdown labels current docs as "latest".After this change, any PR merged to
docs/immediately appears on the live site. No more manual syncing of versioned snapshots.Test plan
npm run build:fastpasses (English only)npm run buildpasses (English + Chinese)diff -rq docs/ versioned_docs/version-v2.8.0/ --exclude="*.json"reports 0 differing files