BZ #1991964 - Show upgrade links under Administer > Upgrade

[adamruzicka]

Links to unversioned documentation which automatically redirects to latest available version and the upgrade helper app

[evgeni]

CI should be fixed once #39 is in

[ekohl]

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
  • Documentation
  • Upgrade helper

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.

• Help
  • Documentation
  • Upgrade
  • Upgrade Helper

Perhaps some documentation people can weigh in here.

[adamruzicka]

We actually have an upgrading guide so why doesn't Upgrade -> Documentation point to that?

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?

[adamlazik1]

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

  • Documentation
  • Upgrade helper

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.

• Help

  • Documentation
  • Upgrade
  • Upgrade Helper

Perhaps some documentation people can weigh in here.

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 Upgrade as the name of the menu item, I hope people will find it easier to understand that they can find the upgrade guide on the linked page. I would be fine with "Help" too, but "Upgrade" is what was specifically requested in the BZ.

[pondrejk]

@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

[adamruzicka]

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.

[ShimShtein]

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.

@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.
We can put the link in the core repo and brand it in the theme, since we already have upstream upgrade docs here: https://theforeman.org/manuals/3.9/index.html#3.6Upgradeto3.9 . This will also have the links in the correct place to be tested for validity.

[adamlazik1]

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.

@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. We can put the link in the core repo and brand it in the theme, since we already have upstream upgrade docs here: https://theforeman.org/manuals/3.9/index.html#3.6Upgradeto3.9 . This will also have the links in the correct place to be tested for validity.

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.

[ShimShtein]

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.