Skip to content

SSoT - Clean up docs under install/

Achilleas Pipinellis requested to merge docs/ssot-installation-guides into master

What does this MR do?

This is an initiative to ensure all documentation complies completely with the Documentation Style Guide section "Documentation is the single source of truth (SSOT)" according to this epic &1280 (closed).

In particular, the changes of this commit touch all files under doc/install/. Most notably:

  • install/redis.md: Redirect to Redis section of install guide.
  • install/pivotal/index.md: Changed its content to reflect the current status, which is no longer supported (since 2017!).
  • install/google-protobuf.md: Incorporated inside installation.md under the troubleshooting section.
  • install/openshift_and_gitlab.md: Clarified that this guide is no longer relevant. We might want to redirect to the Chart docs in the future.
  • install/structure.md: Incorporated inside installation.md under its own section.
  • install/kubernetes/index.md: Redirected to https://docs.gitlab.com/charts.

The type and troubleshooting section was added to almost all docs.

Related issues

Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/61509.

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the ~Documentation label.

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Achilleas Pipinellis

Merge request reports