Add v6 preview docs
Versions v5 docs (./versioned_docs/v5/*) and promotes current (./docs/*) to v6 preview.
URLs:
- https://pester.dev/docs = v5
- https://pester.dev/docs/v5 = v5 (through Netlify redirect)
- https://pester.dev/docs/v6 = v6 preview docs
Includes PesterConfiguration reference in Usage/Configuration page.
Checklist:
- [x] Add Netlify redirect for latest version to stable (/docs/v5/* -> /docs/*) to always support versioned docs URIs
- [x] Add migration docs
- [x] Replace
[PesterConfiguration]::DefaultwithNew-PesterConfigurationin docs - [x] Remove "New in Pester 5.*" comments/tips/badges
- [x] Update/Remove references to "in Pester 5" and similar.
- [x] Generate PesterConfiguration docs in /docs/Configuration file (v6)
- Looking for style input, see https://github.com/pester/docs/issues/280#issuecomment-2166573341
- Related: pester/pester#2505
- [x] Update
generate-pesterconfiguration-docs.ps1to support v5 and current (v6)?- [x] Actually generate PesterConfiguration docs for v5
- [x] Update
generate-command-reference.ps1to support v5 and current (v6)? - [x] Reimplement Github workflow to run scripts above in a clean session
- [ ] Update Assertion-docs (initial draft only)
- [ ] Introduction to new (Should-) vs stable (Should -) assertions?
- [ ] Update Custom Assertion page to stop recommending registering as should operators?
- [ ] Rename Should and Assertion reference pages to
... (v5)?
- [x] Update TestDrive and TestRegistry
- [x] Should we keep /docs/* path for latest stable or always include version like /docs/v5/, /docs/v6/ to avoid breaking in the future?
Fix #312 Fix pester/pester#2459 Fix #280 Related pester/pester#2464
Will it help if I release sooner rather than later?
No hurry. I can build command ref from local build for now.
@bravo-kernel: Thoughts on PR and versioning strategy? Just playing around atm. but considering merging something this week before PSConfEU 🙂
@fflaten I have been AFK and will need to find some time to look at this (soon).
@fflaten awesome job and the preview looks great. Are there any remaining issues you need feedback on?
@fflaten awesome job and the preview looks great. Are there any remaining issues you need feedback on?
Thanks 🙌 My initial review questions was:
- Versioning / URL scheme: Keep pester.dev/docs for current stable? Always versioned?
- There's a related question here
- I believe the current iteration with /docs as stable like before with /docs/v<stable> -> /docs redirect might be best. Will allow both types (so module help can refer to versioned URL) while keeping a stable canonical link for search engines so we keep our rank in search results (improved SEO)
- Changes to generate-scripts incl. how to handle sidebar for versioned docs
- All good? Change/revert something?
- Was wondering if Docusaurus-module could support versioned docs. E.g. update the versioned sidebar json OR at highlight any added/removed pages between updates. Might be an edge case though. Not sure how many use versioned docs for majors only vs minor versions which a new/removed command would typically require.
- PesterConfiguration docs placement and style
- Anything else
Should I split this into multiple PRs maybe?
* Versioning / URL scheme: Keep pester.dev/docs for current stable? Always versioned? * There's a related question [here](https://github.com/pester/docs/pull/267#issuecomment-2169814740) * I believe the current iteration with /docs as stable like before with /docs/v<stable> -> /docs redirect might be best. Will allow both types (so module help can refer to versioned URL) while keeping a stable canonical link for search engines so we keep our rank in search results (improved SEO)
I am not sure what you are suggesting here but also do not really have a preference. We once chose the current logic with stable being /docs and I think it was because it was the Docusaurus default (at that time). Honestly, you have spent a lot of time on this topic so you would probably know best how to proceed here.
* Was wondering if Docusaurus-module could support versioned docs. E.g. update the versioned sidebar json OR at highlight any added/removed pages between updates. Might be an edge case though. Not sure how many use versioned docs for majors only vs minor versions which a new/removed command would typically require.
I think we could do the first option. Will need to investigate but perhaps adding a new -Version parameter is all that is needed to generate/update the correct versioned sidebar (because we already have https://docusaurus-powershell.vercel.app/docs/commands/New-DocusaurusHelp#-sidebar).
* PesterConfiguration docs placement and style
In progress.
Should I split this into multiple PRs maybe?
Not necessary for me at all, we can always quick fix after merging anyway.
New configuration looks great @fflaten
@nohwnd Time for a quick review and maybe merge?
Highlights and questions:
- New temp docs for Assert assertions copied from Pester-repo. Keep or revert for now? https://deploy-preview-316--pester-docs.netlify.app/docs/v6/assertions/should-command
- Title change. Yay / nay ? https://deploy-preview-316--pester-docs.netlify.app/docs/v6/assertions/
- Merged breaking + migration guide for v6? https://deploy-preview-316--pester-docs.netlify.app/docs/v6/migrations/v5-to-v6
- PesterConfiguration reference https://deploy-preview-316--pester-docs.netlify.app/docs/v6/usage/configuration#pesterconfiguration-options
Tips to save time:
- Ignore /docs/commands. Nothing special and will be updated on next alpha release.
- Ignore versioned_v5 folder. Mostly three changes affecting it:
- Updated a mocking helper/snippet, same as v6 page (file: /docs/usage/mocking.mdx)
- Added PesterConfiguration reference to Configuration-page
- Fixed TestDrive-page example to be v5 compatible. Same as v6 page.
Friendly reminder @nohwnd 🙂
@nohwnd Friendly ping 🙂
Bravo!