Skip to content

Update markdown lint style and option files

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

What does this MR do?

This updates the .mdlrc and .mdlrc.style files, used by the markdown lint in docs. It adds a little more information, and all the rules. It enables the rules that pass already, and adds the rest, but commented out into two sections: Should be enabled in the future, and Should not be used currently.

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.

Merge request reports