Adds versioning to documentation. Closes #1999#7188
Conversation
There was a problem hiding this comment.
Pull request overview
Introduces Docusaurus documentation versioning so the published docs can be viewed for the latest stable CLI release and for the beta (“current”) docs.
Changes:
- Add a script to generate a stable docs snapshot from the latest git tag and configure CI to run it before building docs.
- Update Docusaurus configuration to set stable as the default version and expose a version dropdown (stable vs beta).
- Ignore generated versioning artifacts and extend docs cleanup to remove versioned outputs.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/create-docs-versioning.mjs | Generates the stable docs version from the latest git tag and restores the working tree afterwards. |
| docs/package.json | Extends clear to remove Docusaurus versioning artifacts. |
| docs/docusaurus.config.ts | Adds stable/beta version config and a docs version dropdown; updates edit URL. |
| .gitignore | Ignores generated versioned_docs, versioned_sidebars, and versions.json. |
| .github/workflows/release_next.yml | Runs docs versioning preparation before building docs. |
| .github/workflows/deploy_docs.yml | Runs docs versioning preparation before building docs. |
| .github/workflows/check_pr.yml | Runs docs versioning preparation before building docs in PR checks. |
027c801 to
5713a73
Compare
Adam-it
left a comment
There was a problem hiding this comment.
Checked locally ✅
Awesome work
only tircky part is that 11.6 so last stabe version in the about/release-notes show 11.6 as beta 🙂
I get it, because it is build on the last commit from the 11.6 tag, but still looks strange. 🤔. Maybe in the future we could make the release-notes update as a separate commit and add the release tag to that commit. Other than that I don't have anything to add
|
Yes, noticed the release notes as well. We should definitely pay attention to create a separate commit. But I think we can live with it for 1 month. |
Closes #1999
Introduces docs versioning. There will be two versions:
v11.6.0(current stable) andbeta. Docs will automatically treat the latest stable as the default version.A demo of the docs can be found at: https://milanholemans.github.io/cli-microsoft365
To create a local build, just run
node scripts/create-docs-versioning.mjsbefore runningnpm run start.npm run clearwill clear the created versions as well.