Skip to content

Expand version history rule to catch more issues

Marcel Amirault requested to merge docs-update-vale-history-rule into master

What does this MR do?

As part of the work on the related issue, we needed to rewrite the Vale rule that enforces standards for History Items in the docs. The rule was removed in !142348 (diffs)

We added the first iteration of a new rule to match the new standard in !142971 (merged), and this expands that rule to catch the issues we found in !143155 (merged).

The rule now enforces that all version history items start with > -, have one item per line, and have a newline between the history items and the rest of the content.

As this issue can cause history items to render incorrectly on the docs site, and is frequently done incorrectly (as seen by the number of fixes I already had to do in this MR), we should probably set this to error level as well, to fail the pipeline and prevent merge with the incorrect formatting.

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.
Edited by Marcel Amirault

Merge request reports