Versioned documentation on the web site
Versioned Documentation
This PR introduces the possibility of versioned documentation for users on maester.dev/docs!
It also includes a GitHub actions workflow that automatically updates documentation versions and deploys the site after a new GitHub release has been published.
https://github.com/user-attachments/assets/4f2705f8-d991-4c46-95ea-bd84db70707c
This pull request introduces versioned documentation support and several improvements to the Maester.dev website's Docusaurus configuration and documentation. The main changes include automating the deployment of versioned docs when a new release is published, updating the site to display and manage multiple documentation versions, and adding new and updated reference docs for PowerShell commands. Additionally, internationalization support for version banners is enhanced.
Versioned Documentation and Docusaurus Configuration:
- Added a new GitHub Actions workflow (
.github/workflows/publish-versioned-docs.yml) to automatically deploy versioned Docusaurus docs on GitHub Release publication. - Updated
website/docusaurus.config.jsto support multiple documentation versions, including configuration for version labels, banners, and a version dropdown in the navbar. [1] [2] - Migrated the
onBrokenMarkdownLinkssetting to the new markdown hooks API in Docusaurus. [1] [2]
Documentation Content Additions:
- Added new versioned documentation for Maester 1.3.0, including guides for Conditional Access What-If tests and reference docs for PowerShell commands:
Add-MtTestResultDetail,Clear-MtDnsCache,Clear-MtExoCache, andClear-MtGraphCache. [1] [2] [3] [4] [5]
Internationalization and UX Improvements:
- Added i18n JSON files for version banners: unreleased and unmaintained documentation now display clear, localized messages to users. [1] [2]
Documentation and Readme Updates:
- Improved formatting and clarity in the website's
README.md, including clearer code block syntax and section naming.
Contribution Checklist
Before submitting this PR, please confirm you have completed the following:
- [x] 📖 Read the guidelines for contributing to this repository.
- [x] 🧪 Ensure the build and unit tests pass by running
/powershell/tests/pester.ps1on your local system.