Improve clarity in upgrade word description in word list docs
requested to merge gitlab-community/gitlab:daelmo-improve-upgrade-word-description-in-word-list-docs into master
What does this MR do?
The description of upgrade
word in the Style guide's word list seems to be unclear:
It mentions
Installing a newer major (13.0, 14.0) or minor (13.8, 14.5) version of GitLab.
... however (13.8, 14.5) is not a minor change. It could be confusing because the two numbers suggest an upgrade from one to another. To avoid
Further details
Proposal
To void confusion, it could be better to include just one version in the parenthesis. Like this:
Installing a newer major (13.0) or minor (13.2) version of GitLab.
Related issues
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.