Update MD024 Markdownlint rule to latest definition
What does this MR do?
Update Markdownlint rule MD024 to the latest definition.
- Older definition: https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/Rules.md#md024---multiple-headings-with-the-same-content
- Newest definition: https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/Rules.md#md024---multiple-headings-with-the-same-content
Related to gitlab-docs#1761 (closed)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Merge request reports
Activity
changed milestone to %16.9
assigned to @eread
- Resolved by Kati Paizee
@kpaizee Could you review? We've been using a now-removed configuration style for one of our rules, so this moves us to the new way of specifying the same test.
The links to a version of the rules that supported both styles and to the current rule style is in the MR description.
Thanks!
requested review from @kpaizee
Reviewer roulette
Category Reviewer Maintainer .markdownlint.yml
Reviewer review is optional for .markdownlint.yml
@susantacker
(UTC-5, 16 hours behind author)
Please check reviewer's status!
Please refer to documentation page for guidance on how you can benefit from the Reviewer Roulette, or use the GitLab Review Workload Dashboard to find other available reviewers.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
DangerEdited by Ghost Userrequested review from @dianalogan
- Resolved by Kati Paizee
@dianalogan
, thanks for approving this merge request.This is the first time the merge request has been approved. To ensure we don't only run predictive pipelines, and we don't break
master
, a new pipeline will be started shortly.Please wait for the pipeline to start before resolving this discussion and set auto-merge for the new pipeline. See merging a merge request for more details.
added pipeline:mr-approved label
removed review request for @dianalogan
mentioned in merge request gitlab-runner!4610 (merged)
enabled an automatic merge when all merge checks for 73221167 pass
mentioned in commit 33985c7d
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added workflowpost-deploy-db-staging label and removed workflowproduction label
added workflowpost-deploy-db-production label and removed workflowpost-deploy-db-staging label
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label
added pipelinetier-3 label