Skip to content

Make the titles of the advanced configuration docs parallel

Achilleas Pipinellis requested to merge axil-advanced-config-docs-rename-headings into master

What does this MR do?

For the pages in the advanced section, make the page titles parallel. They need to be phrased in the same way, and have the same capitalization. Right now, here is what those page titles look like:

Bringing your own images
External PostgreSQL database 
Configure this chart with External Gitaly
Configure this chart with External GitLab Pages
Configure This Chart with Mattermost Team Edition
External NGINX Ingress Controller
External object storage
Configure this chart with External Redis
GitLab with FIPS-compliant images
GitLab Geo
Using TLS between components
Managing Persistent Volumes
GitLab with UBI-based images

Pages that I left out:

  • doc/advanced/external-db/index.md: this is tackled separately, see !2752 (merged)
  • doc/advanced/external-db/external-omnibus-psql.md: this should be replaced with another doc, as it's duplicate. See #3507.
  • doc/advanced/external-gitaly/external-omnibus-gitaly.md: this should be replaced with another doc, as it's duplicate. See #3507
  • doc/advanced/external-redis/external-omnibus-redis.md: this should be replaced with another doc, as it's duplicate. See #3507

Related issues

gitlab-org/technical-writing#642 (closed)

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

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

Review 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 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.
    • 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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports