Skip to content

Docs: add Vale test for warning-level substitutions

Amy Qualls requested to merge 211983-docs-aqualls-substitution-warnings into master

What does this MR do?

There are some word choices we want to disallow in the future, but the cleanup to get rid of them requires more time than we can spend on the entire docset at this time. A moderate approach would be to create a warning-level (as opposed to error-level) substitution test for these word pairs, so we can start cleaning out the informal versions of these words over time. If we focus on cleaning up all instances of a word and occurrences hit zero, we can move a word from the warnings file to the errors file.

Related issues

Closes #211983 (closed)

Author's checklist (required)

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

  • Optional: 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.

Merge request reports