Skip to content

Test for existence of H6 and H7 subheadings

Amy Qualls requested to merge aqualls-test-h6-plus into master

What does this MR do?

This test is truly janky and MVC. It attempts to flag every H6 and H7 subheading, per the discussion in Note maximum Markdown heading depth for docs (!93783 - merged) that subheadings deeper than H5 are unstyled. (Also, just not good ideas in general.)

Adds two warning level rules to our rule set.

Notes:

  • I tried using scope: heading but I couldn't get it to capture ###### or #######.
  • scope: only supports one item at a time, so you can't concatenate into a single rule like scope: heading.h6, heading.h7
  • We might want to file an issue with Vale - we can't be the only ones to have this idea
  • The link needs to be updated after Note maximum Markdown heading depth for docs (!93783 - merged) merges

Related issues

Related to !93783 (merged)

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 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.
Edited by Amy Qualls

Merge request reports