Skip to content

Docs: Clean up headers in markdown

Marcel Amirault requested to merge docs-markdown-header-lint into master

What does this MR do?

Continuing in the effort to standardize the markdown implementation across all docs. This MR cleans up headers, by ensuring the first header is a top level header, and that there is only one top level header per doc. Also, all headers have blank lines above and below, and exactly one space after the hash marks.

When desired, the markdown rules below can be enabled after this is merged (see https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/30595):

  • MD002 First header should be a top level header
  • MD018 No space after hash on atx style header
  • MD019 Multiple spaces after hash on atx style header
  • MD025 Multiple top level headers in the same document

Related issues

https://gitlab.com/gitlab-org/gitlab-ce/issues/64352

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 Marcia Ramos

Merge request reports