Skip to content

Docs: Fix spacing of code blocks

Marcel Amirault requested to merge docs-code-block-style into master

What does this MR do?

Standardizing Markdown in the docs:

Code blocks should not be spaced 4 spaces in, as this will break code coloring in GitLab. The code blocks should also be spaced identically to any list that they are a part of.

This MR fixes many instances of this, as found by the markdown lint, for rule MD046 (but does not enable the rule just yet). There are more not found by the lint, which I will fix in another MR.

Related issues

https://gitlab.com/gitlab-com/gitlab-docs/issues/397

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 Marcel Amirault

Merge request reports