Skip to content

Update upgrade paths section

What does this MR do?

The upgrade paths section has been discussed quite a few times, and some folks find it confusing.

This MR:

  • Turns the upgrade paths into a list for better visibility
  • Removes table of examples as it was confusing and duplicate effort

before after
https://docs.gitlab.com/ee/update/#upgrade-paths https://main-ee-109875.docs.gitlab-review.app/ee/update/index.html#upgrade-paths
Screenshot_2023-01-31_at_15-21-09_Upgrading_GitLab_GitLab Screenshot_2023-01-31_at_15-20-46_Upgrading_GitLab_GitLab

Related issues

Latest discussion where the upgrade paths section confused folks #388928 (comment 1249268118).

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

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 like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure 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.

Merge request reports

Loading