Skip to content

Quality-of-life markdownlint YAML improvements

Amy Qualls requested to merge aqualls-tidy-markdownlint-yaml into master

What does this MR do?

Revises .markdownlint.yml with these goals:

  • Put the settings in alphabetical order, with two sensible exceptions: default: true should go first, and proper-names: is long so let's move it last
  • Add tidy inline comments with the rule number. Markdownlint updates typically reference rules by their number, and future us will be grateful that we can grep for the rule number and know whether or not a deprecation affects us.
  • Add URL to full rule list. Not everyone knows where this is, and because we touch this file so rarely, it's helpful to not have to thrash.

Related issues

Author's checklist

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 like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure 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

Loading