Skip to content

Remove guideline about dashes and imgs

Marcin Sedlak-Jakubowski requested to merge msj-remove-dashes into master

What does this MR do?

The Documentation Style Guide section on images has this guideline:

If a heading is placed right after an image, always add three dashes (---) between the image and the heading.

However, it's not followed by the team - this pattern[1] was present in only three files (added to this MR), and I think all of these were added by me 😅

[1]

png)

---

##

As opposed to 163 files in gitlab, gitlab-runner and omnibus repos, which have headings directly following an image.

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

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.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports