Skip to content
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

Add v6 preview docs #316

Open
wants to merge 32 commits into
base: main
Choose a base branch
from
Open

Add v6 preview docs #316

wants to merge 32 commits into from

Conversation

fflaten
Copy link
Collaborator

@fflaten fflaten commented Jun 13, 2024

Versions v5 docs (./versioned_docs/v5/*) and promotes current (./docs/*) to v6 preview.

URLs:

Includes PesterConfiguration reference in Usage/Configuration page.

Checklist:

  • Add Netlify redirect for latest version to stable (/docs/v5/* -> /docs/*) to always support versioned docs URIs
  • Add migration docs
  • Replace [PesterConfiguration]::Default with New-PesterConfiguration in docs
  • Remove "New in Pester 5.*" comments/tips/badges
  • Update/Remove references to "in Pester 5" and similar.
  • Generate PesterConfiguration docs in /docs/Configuration file (v6)
  • Update generate-pesterconfiguration-docs.ps1 to support v5 and current (v6)?
    • Actually generate PesterConfiguration docs for v5
  • Update generate-command-reference.ps1 to support v5 and current (v6)?
  • 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)?
  • Update TestDrive and TestRegistry
  • 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

@nohwnd
Copy link
Member

nohwnd commented Jun 13, 2024

Will it help if I release sooner rather than later?

@fflaten
Copy link
Collaborator Author

fflaten commented Jun 13, 2024

No hurry. I can build command ref from local build for now.

@fflaten
Copy link
Collaborator Author

fflaten commented Jun 15, 2024

@bravo-kernel: Thoughts on PR and versioning strategy? Just playing around atm. but considering merging something this week before PSConfEU 🙂

@bravo-kernel
Copy link
Collaborator

@fflaten I have been AFK and will need to find some time to look at this (soon).

@bravo-kernel
Copy link
Collaborator

@fflaten awesome job and the preview looks great. Are there any remaining issues you need feedback on?

@fflaten
Copy link
Collaborator Author

fflaten commented Jun 17, 2024

@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?

@bravo-kernel
Copy link
Collaborator

* 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.

This was referenced Jun 18, 2024
@bravo-kernel
Copy link
Collaborator

New configuration looks great @fflaten

@fflaten fflaten marked this pull request as ready for review June 20, 2024 14:24
@fflaten
Copy link
Collaborator Author

fflaten commented Jun 20, 2024

@nohwnd Time for a quick review and maybe merge?

Highlights and questions:

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:

docs/usage/configuration.mdx Outdated Show resolved Hide resolved
@fflaten
Copy link
Collaborator Author

fflaten commented Jul 20, 2024

Friendly reminder @nohwnd 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants