-
Notifications
You must be signed in to change notification settings - Fork 16
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
BZ #1991964 - Show upgrade links under Administer > Upgrade #38
base: develop
Are you sure you want to change the base?
Conversation
Links to unversioned documentation which automatically redirects to latest available version and the upgrade helper app
519250a
to
e6ae4f0
Compare
CI should be fixed once #39 is in |
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 can't really say I'm too happy about the menu structure but 👍 from a technical point of view.
As I read it you now have:
- Upgrade
We actually have an upgrading guide so why doesn't Upgrade -> Documentation point to that?
Throwing an alternative idea out there: add a Help
top level item.
Perhaps some documentation people can weigh in here.
If i understand it correctly the "upgrading guide" is versioned and "6.14 upgrading guide" describes how to upgrade to 6.14. So on a 6.14 we should point to 6.15 docs, but 6.14 doesn't know when 6.15 docs will be published and might lead to us linking to a page that doesn't exist? |
Unfortunately, we cannot link the exact guide, because as stated, upgrade links for version X should point to documentation on how to upgrade to version X+1, which does not exist upon release of version X. By having |
@adamruzicka Tried on stream + packit, the links are there and land where they should. But I have a usability concern with those, it is not apparent that these are links, clicking on the navigation element in the tree gets you straight outside of satellite without any warning or prompt for confirmation which I think is an unpleasant surprise. It also happens when you use navigation tree search, you select upgrade helper and you follow the link straight away I suggest having a page with the link, where this navigation elements would get you. There you could decide if you want to follow the link or not. It would also be easier to add more links in the future |
@ahumbe Opinions on the above? While I agree with the above, it wouldn't be a small change anymore if we decided to go that way. |
@adamlazik1 , can we create a placeholder page in the documentation that will state something like "This would be relevant once we release our next Satellite version". Then we will have the link pointing there using the usual scheme. |
I am not certain if users who install a new version of Satellite want to see a link to non-existing docs in the UI. Personally, I prefer the way links are right now. But of course, the final decision is not up to me. Just my two cents. |
Perhaps a redirect on the cloud side would be a better solution. 🤔 This way we can change the redirect target once the documentation would be available. |
Links to unversioned documentation which automatically redirects to latest available version and the upgrade helper app