Skip to content

Create inclusive-language tests

Amy Qualls requested to merge docs-aqualls-inclusive-language-tests into master

What does this MR do?

Creates three new tests for inclusive language, and links to them from the appropriate place in the style guide:

  1. InclusionAbleism.yml - suggestion level
  2. InclusionCultural.yml - warning level (explanation follows)
  3. InclusionGender.yml - suggestion level

I bumped the InclusionCultural.yml test from suggestion to warning because it's only testing for the following words, and the blacklist / whitelist test was previously at the warning level in the SubstitutionWarning.yml test:

swap:
  blacklist(ed|ing)?: denylist
  whitelist(ed|ing)?: allowlist
  master: primary
  slave: secondary

Related issues

Closes technical-writing#120 (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.
    • Ensure docs metadata are present and up-to-date.
    • Ensure Technical Writing and documentation are added.
    • Add the corresponding docs:: scoped label.
    • Add twdoing when starting work on the MR.
    • Add twfinished if Technical Writing team work on the MR is complete but it remains open.

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

Merge request reports

Loading