Skip to content

Change mdl to markdownlint for docs linting

Marcel Amirault requested to merge mdl-to-markdownlint into master

What does this MR do?

This MR changes the markdown lint test to use the node markdownlint instead of the ruby mdl. This test is fast, more actively updated, and is available as a plugin for most editors (including VS Code, Sublime and Atom), making it an ideal choice for the docs. I did not find any false positives, and could thus enable all rules.

This MR also adds the configuration file, pre-configured to match the docs standards.

Related issues

Related to https://gitlab.com/gitlab-org/gitlab-ce/issues/64352
Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/65806

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