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

Update docs for v1.6.0 RC2 #3660

Closed
wants to merge 4 commits into from
Closed

Conversation

carlisia
Copy link
Contributor

@carlisia carlisia commented Apr 2, 2021

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:

Carlisia added 2 commits April 2, 2021 15:51
Signed-off-by: Carlisia <carlisia@vmware.com>
Signed-off-by: Carlisia <carlisia@vmware.com>
@github-actions github-actions bot added Documentation has-changelog Website non-docs changes for the website labels Apr 2, 2021
@carlisia carlisia requested review from dsu-igeek and removed request for nrb April 2, 2021 23:00
Copy link
Member

@ashish-amarnath ashish-amarnath left a 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>
Copy link
Member

@ashish-amarnath ashish-amarnath left a 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!

Copy link
Contributor

@zubron zubron left a 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.

@ashish-amarnath
Copy link
Member

That makes sense. Thanks for that info @zubron
I agree that we don't want our pre-release to get a GA version string in the docs.
Sorry I missed that @carlisia.

@carlisia
Copy link
Contributor Author

carlisia commented Apr 5, 2021

Haha I didn't trust the docs. The ones I wrote.

Closing this and opening a new one.

@carlisia carlisia closed this Apr 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants