Skip to content

Fix vale plural rule to ignore code blocks

Marcel Amirault requested to merge docs-vale-plurals-tweak into master

What does this MR do?

I was reviewing https://docs.gitlab.com/ee/ci/unit_test_reports.html#number-of-recent-failures locally and noticed that vale flagged the (s) in the code sample, which is a false positive. After checking the rule, I realized we were accidentally using scope: raw, which lints into code blocks. From a quick scan, there were several other false positives due to this.

Removing the scope: raw brought the results from ~30 with false positives, down to 12 with zero false positives that I could see (our style guide section about (s) usage, and some UI elements that have (s) hard coded).

I also fixed the link to point to the related section in the word list.

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 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