Improve Upgrade documentation for Runner
Problem to solve
When we link users to upgrade their runners from the UI (based on this feature), we are linking them directly to the install page. There is no mention of upgrading runners on the landing page, but each execution environment contains its own section for upgrading. For new users especially, this can be confusing because they aren't sure why they are left on the install page and what to do next.
Further details
a quick note from a disconnected MR review I'm working, the link on this popover leads to
install runners
notupgrade runners
:
You should create an issue about this if there isn't one.Looks like there's no section in the docs for upgrading runners.
Proposal
The smallest change:
- Add an
Upgrade
section on the Install page that links to each execution environment's upgrade section. That would look something like..
Upgrade GitLab Runner |
---|
Follow the upgrade instructions that match how you installed GitLab Runner. |
A future consideration that could better match how the doc sidebar is split up:
- Add a new section in the sidebar called
Upgrade GitLab Runner
. This can be placed underneath Configure GitLab Runner, and we can copy the format that Install GitLab Runner uses as far as sections (execution environment).