use "latest" dir for API docs in doc URLs on the web site #1970
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joshuatcasey
approved these changes
May 28, 2024
|
Merging and bypassing CI since this is only a |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When we released Pinniped v0.30.0, we included generated code for Kubernetes 1.30. The release process updated this config file for our web site to say 1.30: https://github.com/vmware-tanzu/pinniped/blob/main/site/config.yaml#L11
Sadly, 1.30 in YAML means the decimal value 1.3, not the string "1.30". This broke many API doc links on our web site because they accidentally use 1.3 where they should use 1.30.
This PR changes all those links to use
https://github.com/vmware-tanzu/pinniped/blob/main/generated/latest/README.adocinstead of interpolating the specific version number likehttps://github.com/vmware-tanzu/pinniped/blob/main/generated/1.30/README.adoc.Release note: