[go: up one dir, main page]

Skip to content

Organize upgrade docs into three overarching sections

Problem to solve

Our upgrade documentation at https://docs.gitlab.com/update/ presents a lot of information, but not all of it is organized in the order it's needed in.

Further details

When looking over the upgrade documentation, it isn't clear what's relevant:

  • Before doing an upgrade.
  • While doing an upgrade.
  • After doing an upgrade.

It means that a person that wants to upgrade their GitLab instance has to scan over all the documentation and self-organize the information in a way that makes sense.

We should make it easier for readers to know what they need to be aware of before doing and upgrade, and that they won't need until they want to start.

We need to make it easier to know what resources are available when an upgrade was completed successfully or unsuccessfully.

Proposal

Let's organize the upgrade documentation into three main areas:

  • Pre-upgrade
  • Upgrade
  • Post-upgrade

All the documentation can be categorized into one of those three.

With thanks to @sselhorn for doing the necessary analysis for this. 🙇🏻

Who can address the issue

@eread, technical writer for groupSelf Managed

Other links/references

Edited by Evan Read