Skip to content

Attempts to fix Units.yml false positive for '1st'

Amy Qualls requested to merge 387748-aqualls-fix-test into master

What does this MR do?

In #387748, @sarahgerman caught a problem where the Units.yml test flagged an instance of 1st as being a unit-plus-number (1s). While low priority, let's see if we can fix it. My first idea is to add a word boundary character after the s in the regex.

The problem page identified in !108134 (merged) was doc/ci/pipelines/cicd_minutes.md, which has since moved to doc/ci/pipelines/compute_minutes.md.

# See the findings locally
$ vale --no-wrap --filter='.Name=="gitlab.Units"' doc/**/*.md
  • Before: 126 findings
  • After: 124 findings

When I restored the text in doc/ci/pipelines/compute_minutes.md, the previous false positives were NOT flagged. Also, these false positives were eliminated:

  • doc/architecture/blueprints/ci_scale/index.md line 27
  • doc/topics/cron/index.md line 45

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

Merge request reports

Loading