Update usage of upgrade/update in the docs
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Problem to solve
We use upgrade and update somewhat inconsistently in our documentation. Let's use this issue to correct that.
Further details
We recently updated the docs styleguide to make it more clear when to use one over the other:
- https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#update
- https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#upgrade
Use upgrade for:
- Choosing a higher subscription tier (Premium or Ultimate).
- Installing a newer major (13.0, 14.0) or minor (13.8, 14.5) version of GitLab.
For example:
- Upgrade to GitLab Ultimate.
- Upgrade GitLab from 14.0 to 14.1.
- Upgrade GitLab from 14.0 to 15.0.
Use caution with the phrase Upgrade GitLab without any other text. Ensure the surrounding text clarifies whether you’re talking about the product version or the subscription tier.
Use update for installing a newer patch version of the software only. For example:
- Update GitLab from 14.9 to 14.9.1.
Other links/references
Implementation guide
Scan the documentation for references of upgrade or update and make sure they follow the styleguide.
Contact person: @axil
Edited by 🤖 GitLab Bot 🤖