Skip to content

Docs: fix errors on infra page, build ordered lists

Amy Qualls requested to merge 217144-docs-aqualls-make-list into master

What does this MR do?

The changes recently merged to the infrastructure page (https://docs.gitlab.com/ee/user/infrastructure/index.html) did not completely incorporate my edits, and the page is broken as a result. The (long) example YAML file was included twice, and the numbered list restarted at 1 in a few places because of code blocks that weren't fully indented.

This MR:

  • adds in consistent line breaks to the page
  • rewrites several small subheadings to be a single list of numbered steps
  • brings page closer to GitLab tone and style
  • fixes the problem with the doubled copy of the code example

Related issues

Closes #217144 (closed)

Author's checklist (required)

When applicable:

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.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports