Skip to content

Remove header gerund rule from Vale

Craig Norris requested to merge docs-vale-gerund-rem into master

What does this MR do?

Although our style would have us avoid the use of gerunds when creating headers, this rule is reporting on so many pre-existing violations of this rule that its reporting has the potential to hide other rules we should be enforcing. Over time, and after greater implementation of CTRT, we should see the number of headers with gerunds be reduced to a manageable number. At that time, it may be worthwhile to put this rule back in place, and possibly at the warning level to expand the group of content contributors who may be aware of the need to address this item in content.

Until then, it's creating a backlog of suggestions that we won't likely directly address, will be addressed by a side effort, and has the potential of obscuring other Vale messages we should be aware of.

As such, this MR removes the Vale rule for checking gerunds in headers for the time being.

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review 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.
    • 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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports