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

V3: Update the Registry to remove the v1 docs and preserve the v2 docs #3420

Open
thomas11 opened this issue Jul 8, 2024 · 4 comments
Open
Assignees
Labels
3.0 area/docs Improvements or additions to documentation kind/enhancement Improvements or new features
Milestone

Comments

@thomas11 thomas11 added area/docs Improvements or additions to documentation 3.0 labels Jul 8, 2024
@mikhailshilkov mikhailshilkov added the kind/enhancement Improvements or new features label Jul 9, 2024
@cleverguy25
Copy link

Added to epic https://github.com/pulumi/home/issues/3552

@EronWright
Copy link
Contributor

EronWright commented Jan 15, 2025

Note the useful requirements mentioned in pulumi/registry#2879:

Please make Azure Native v1 docs available (v1.104.0) in the registry.

  • v1 docs are expected to remain for ~6 months
  • v1 doc updates are understood to require manual updates and the expectation is that any further updates to v1 will be rare and only in urgent security related updates. There is no further development planned for v1.
  • Search should prefer v2 and exclude v1.
  • Azure v2 docs should have a link to v1 available so that users that navigate to v2 docs are able to find the v1 docs.
  • It should be clear which version (v1, v2) of the docs are being viewed.
  • v1 docs should include notifications that v2 is available and recommended.

@EronWright
Copy link
Contributor

PRs are ready and being held until v3 is released.

@thomas11
Copy link
Contributor Author

Planning note: we can release a v3-alpha from the v3 branch and point the v3 docs to it, for testing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.0 area/docs Improvements or additions to documentation kind/enhancement Improvements or new features
Projects
Status: In Progress
Development

No branches or pull requests

5 participants