Skip to content

Docs note style lint expansion

Marcel Amirault requested to merge docs-note-style into master

What does this MR do?

As flagged by @bbodenmiller, our Vale rule is still letting a lot slip through: #229441 (comment 381674982)

This expands the rule to find multiple variations of notes that aren't following the style guide:

  • Notes at the start of a line that are just **Note:**, without NOTE:, and also *Note:*, and various capitalization possibilities.

Related issues

Related to #229441 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcel Amirault

Merge request reports