Merge version-specific changes update docs for all installation methods
Problem to solve
We have version-specific changes with each minor version that users need to follow when upgrading. Those are scattered in various pages and are hard to follow:
- Generic https://docs.gitlab.com/ee/update/#version-specific-upgrading-instructions
- Omnibus https://docs.gitlab.com/omnibus/update/#version-specific-changes
- Geo https://docs.gitlab.com/ee/administration/geo/replication/version_specific_updates.html
- Charts https://docs.gitlab.com/charts/releases/
Proposal
Create specific version-specific pages which will include information based on the major version, like we now do for Omnibus (for example gitlab_14_changes.md
).
- Then, we should merge the following specific info:
- Each doc will have an H2 heading with the minor release, and specific update changes for:
- Omnibus/Docker
- Source
- Geo
We'll need to think how Charts will fit into this. They have specific instructions as well, but their versioning is not the same as GitLab's https://docs.gitlab.com/charts/releases/.
Who can address the issue
The TW team.
Other links/references
Steps
-
Create a template doc for all changes (General, Package, Source, Geo, etc.) -
Move Omnibus changes under the GitLab repository: -
Move https://docs.gitlab.com/omnibus/update/gitlab_14_changes.html to doc/update/gitlab_14_changes.md
-
Move https://docs.gitlab.com/omnibus/update/gitlab_13_changes.html to doc/update/gitlab_13_changes.md
-
Move https://docs.gitlab.com/omnibus/update/gitlab_12_changes.html to doc/update/gitlab_12_changes.md
-
Move https://docs.gitlab.com/omnibus/update/gitlab_11_changes.html to doc/update/gitlab_11_changes.md
-
-
Move the versions sections that are shown under https://docs.gitlab.com/ee/update/#version-specific-upgrading-instructions to their respective location. -
Update the section in https://docs.gitlab.com/ee/update/#version-specific-upgrading-instructions to include information from: -
Rename https://docs.gitlab.com/ee/update/#version-specific-upgrading-instructions to https://docs.gitlab.com/ee/update/#version-specific-changes -
Redirect https://docs.gitlab.com/ee/administration/geo/replication/version_specific_updates.html to https://docs.gitlab.com/ee/update/#version-specific-changes. -
Update https://docs.gitlab.com/ee/update/package/#version-specific-changes to link back to https://docs.gitlab.com/ee/update/#version-specific-changes
Edited by Alexandr Tanayno