Skip to content

WIP: #47704 adding markdown linter

06kellyjac requested to merge 06kellyjac/gitlab-ce:47704_markdown_linter into master

What does this MR do?

This MR adds markdown linting in the same style as MR 27579

Relevant Issues/Epics: #47704 (closed) &221

Does this MR meet the acceptance criteria?

Conformity

Performance and testing

There has been some discussion in #47704 (closed) about appropriate rules for the markdown linter. I've added the ones listed but there are still 2535 linter complaints.

markdownlint . 2>&1 | wc -l

For this CI job I've set the image as my markdownlint-cli image hosted on GitLab registry.gitlab.com/06kellyjac/docker_markdownlint-cli. I obviously have a bias for my own image and while it's identical to many others mine is on a timer to rebuild every 15 minutes so if we use the latest tag it should be the most up-to-date image. I can change it to a Docker Hub or Quay hosted copy but I thought the GitLab one would be the fastest and just makes sense.

If there is a preference for a different image please let me know.

I've also looked into remark-lint as mentioned a couple times in the issue but I haven't seen much of a quantitative difference.

For the actual markdown fixes I'm more than happy to do them all once we've decided on a nice rule set.

Edited by 06kellyjac

Merge request reports