Skip to content

Reorder and rename sections in variables doc

Marcel Amirault requested to merge docs-ci-variables-ctrt-1 into master

What does this MR do?

As part of the related issue, begins to get sections into their final locations within the CI/CD variables doc. This MR:

  • Renames sections as per current standards.
  • Shuffles the sections around a bit so that the groupings are better (as well as nesting).
  • Removes a handful of superfluous headers.
  • Removes outdated/unneeded screenshots.

See screenshots below to get an overview of the reorganization. It does not change the content in most areas, though there are some tweaks to make the sections work in the new places, or to make sure content isn't lost when we removed the extra headers.

The unfortunate side effect of trying to improve one of the most crosslinked pages in the docs is that renaming headers results in a lot of broken anchor links. This MR also updates all those links, and sometimes removes the anchors when the crosslink is about variables in general and doesn't need to link to a specific section.

Finally, we also crosslink to some of these sections from the UI, so we will need a frontend maintainer to do the final merge.

Screenshots

Before After
Screenshot_2023-01-04_at_23.24.50 Screenshot_2023-01-04_at_23.24.09

Related issues

Related to #382363 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

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

Reviewer's 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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

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

Merge request reports