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

No actual documentation behind link to upstream docs #501

Open
timirnich opened this issue Nov 26, 2024 · 2 comments
Open

No actual documentation behind link to upstream docs #501

timirnich opened this issue Nov 26, 2024 · 2 comments
Assignees

Comments

@timirnich
Copy link

For more information regarding how the `rke2-upgrade` image performs the upgrade, see the link:https://github.com/rancher/rke2-upgrade/tree/master[upstream] documentation.

The link points to the GitHub repo for the upstream docs, which does not contain any actual documentation for the upgrade process. We should probably point to https://docs.rke2.io/upgrade/automated_upgrade instead.

@hardys hardys self-assigned this Dec 16, 2024
@hardys
Copy link
Contributor

hardys commented Dec 16, 2024

Thanks @timirnich the main issue is https://docs.rke2.io/upgrade/automated_upgrade seems to mostly talk about SUC - and it links to the exact same upstream GH repos so I'm not sure replacing the link will make things clearer 🤔

@ipetrov117 what are your thoughts?

@ipetrov117
Copy link
Contributor

ipetrov117 commented Dec 16, 2024

My 2 cents.. IMO the https://docs.rke2.io/upgrade/automated_upgrade documentation does not offer much additional information and might cause confusion. Mainly because there they have a whole section explaining how to install SUC and configure its RKE2 plans which is in contradiction with the installation/configuration process that we want to suggest to our users. That is the main reason why we are not pointing to this documentation.

That said, if we want to point to this documentation instead, I am not opposed to it. I am a bit worried that it might mislead users to thinking that it is okay to install SUC from the upstream repo instead of the Rancher charts. Same concern is valid for the SUC Plans in the automated_upgrade documentation, I am worried that users might think that it is okay to use them instead.

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

No branches or pull requests

3 participants