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

Information about version pinning missing #2530

Open
stdevel opened this issue Oct 18, 2023 · 6 comments
Open

Information about version pinning missing #2530

stdevel opened this issue Oct 18, 2023 · 6 comments

Comments

@stdevel
Copy link
Contributor

stdevel commented Oct 18, 2023

When installing Uyuni Server or Proxy, the installation documentation points to using the "latest and greatest" repository. In some cases, users might not want to use the very latest version of Uyuni, but the version before.

Also, when having a very outdated version of Uyuni, updating to the most recent version is likely to fail.

Documentation Update Required

It would be great to have a not about version pinning in the "Install Uyuni Server with openSUSE" section.

Let me know if you basically think that this is a good idea. I can create a PR for you.

What does the documentation say now?

It simply suggests using the very latest repository packages.

What change is required?

A note could be added.

What content needs to be added?

The documentation should mention additional repository URLs deoending on architecture and type (Server, Proxy):

Subject Matter Expert (SME)

I don't know.

Version

Which version of the software is this feature/update expected to land in (if known)? Next?
Which version of the documentation must this feature/update land in (if known)? Next?
Does the content need to be backported to previous documentation versions (if known)? Would be useful, so yes.

Internal SUSE Reporters

This repository is public.
If you are reporting an issue that needs to remain company confidential, please use the internal Bugzilla instance instead.

@juliogonzalez
Copy link
Member

Hello!

The Snapshots are not supported, only the latest Uyuni version (Stable) is, as it's a rolling release product and updates should be applied frequently.

So the Snapshot should not be part of the documentation. However they can be used for testing, and if the user needs to migrate to intermediate version (on its own), before going to the latest, such workaround could be used (again, not supported, Snapshots are not even tested).

So I'd suggest documenting them at the site, clearly specifying the limitations.

@stdevel
Copy link
Contributor Author

stdevel commented Oct 19, 2023

Thanks for your opinion, @juliogonzalez - just created PR #2536 regarding this. What do you think? Is the wording okay?

@juliogonzalez
Copy link
Member

Not being supported, I'd put this on the site, rather than on the documentation.

Not only it's not supported, it can require more stuff such as matching the right OS for the right snapshot for example.

But ultimately it's for the doc team to decide where they want to handle, of course :-)

@keichwa
Copy link
Contributor

keichwa commented Oct 23, 2023

Maybe, it would be the best to add some such note to https://www.uyuni-project.org/pages/devel-version.html? Then we could consider whether we want to reference it from installation instructions. This hopefully would not confuse users.

@juliogonzalez
Copy link
Member

Maybe, it would be the best to add some such note to https://www.uyuni-project.org/pages/devel-version.html? Then we could consider whether we want to reference it from installation instructions. This hopefully would not confuse users.

I'd better consider a new snapshots.html page for this. The instructions are going to be different from what devel looks like, including the warnings, and we should not even have a list of repositories for client tools, as we don't have snapshots for them.

@keichwa
Copy link
Contributor

keichwa commented Dec 13, 2023

I'd better consider a new snapshots.html page for this. The instructions are going to be different from what devel looks like, including the warnings, and we should not even have a list of repositories for client tools, as we don't have snapshots for them.

Sure, such a new page would be helpful. Then we could add a warning note to the product documentation and provide a link the the new page. I guess we must add the new page to https://github.com/uyuni-project/uyuni-project.github.io to the pages directory as HTML? (I never contributed to that repo.)

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

Successfully merging a pull request may close this issue.

3 participants