Skip to content

Fix spacing for ordered lists - User docs

Marcel Amiraultrequested to merge
docs-ordered-list-whitespace-3 into master

What does this MR do?

While reviewing an MR, I noticed a few of the ordered lists had incorrect spacing which was breaking code coloring when viewing the file in the diff. If you check this MR's diff, you'll see that most things in the "red" side are all colored red due to the incorrect spacing, while the "green" side is colored correctly.

I did a quick search and found quite a few more examples of this, so I figured I should clean them up. I only made changes when it was trivially clear what indentation was intended, you can often see the lines directly above or below are using different (correct) indentation.

This cleans up all the docs in:

  • doc/user
  • A handful of user docs outside doc/user.

Related issues

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