-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Update docs for v1.6.0 RC2 #3660
Conversation
Signed-off-by: Carlisia <carlisia@vmware.com>
Signed-off-by: Carlisia <carlisia@vmware.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
upgrade-to-1.6.md
references the rc-1 release, that needs to be changed to rc-2
Signed-off-by: Carlisia <carlisia@vmware.com>
Signed-off-by: Carlisia <carlisia@vmware.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for making the changes!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was looking through the previous PR for the docs upgrade and noticed this comment: #3659 (review).
It's correct that we don't create a new version of the docs for each patch release, but our site and scripts are set up to assume that the full version string is used for pre-release versions: https://github.com/vmware-tanzu/velero/blob/main/hack/release-tools/gen-docs.sh#L37-L39.
Using v1.6 as the version for an RC means that the header on the docs looks like it's an out of date version: https://deploy-preview-3660--velero.netlify.app/docs/v1.6/ due to this.
It's not that I feel particularly strongly about this, it's just that using the GA version string for a pre-release doesn't match what our docs and scripts include, so we should either update the docs and scripts, or use the full version string.
Haha I didn't trust the docs. The ones I wrote. Closing this and opening a new one. |
Thank you for contributing to Velero!
Please add a summary of your change
Does your change fix a particular issue?
Fixes #(issue)
Please indicate you've done the following:
/kind changelog-not-required
.site/content/docs/main
.