Commit a15d40ac authored by Amy Qualls (slowly returning after surgery)'s avatar Amy Qualls (slowly returning after surgery) Committed by Evan Read

Create a test for ableist words

Begin testing for words that are ableist in nature.
parent 57c574fc
---
# Suggestion: gitlab.InclusionAbleism
#
# Suggests alternatives for words that foster ableism.
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: substitution
message: 'Use inclusive language. Consider "%s" instead of "%s".'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#inclusive-language
level: suggestion
ignorecase: true
swap:
sanity (?:check|test): check for completeness
dummy: placeholder
---
# Warning: gitlab.InclusionCultural
#
# Suggests alternatives for words that are culturally inappropriate.
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: substitution
message: 'Use inclusive language. Consider "%s" instead of "%s".'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#inclusive-language
level: warning
ignorecase: true
swap:
blacklist(?:ed|ing|s)?: denylist
whitelist(?:ed|ing|s)?: allowlist
master: primary
slave: secondary
---
# Suggestion: gitlab.InclusionGender
#
# Suggests alternatives for words that are gender-specific.
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: substitution
message: 'Use inclusive language. Consider "%s" instead of "%s".'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#inclusive-language
level: suggestion
ignorecase: true
swap:
mankind: humanity, people
manpower: GitLab team members
he: they
his: their
she: they
hers: their
...@@ -12,7 +12,6 @@ level: warning ...@@ -12,7 +12,6 @@ level: warning
ignorecase: true ignorecase: true
swap: swap:
admin: administrator admin: administrator
blacklist(ed|ing)?: denylist
code base: codebase code base: codebase
config: configuration config: configuration
distro: distribution distro: distribution
...@@ -20,4 +19,3 @@ swap: ...@@ -20,4 +19,3 @@ swap:
filesystem: file system filesystem: file system
info: information info: information
repo: repository repo: repository
whitelist(ed|ing)?: allowlist
...@@ -418,8 +418,11 @@ We strive to create documentation that is inclusive. This section includes ...@@ -418,8 +418,11 @@ We strive to create documentation that is inclusive. This section includes
guidance and examples in the following categories: guidance and examples in the following categories:
- [Gender-specific wording](#avoid-gender-specific-wording). - [Gender-specific wording](#avoid-gender-specific-wording).
(Tested in [`InclusionGender.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionGender.yml).)
- [Ableist language](#avoid-ableist-language). - [Ableist language](#avoid-ableist-language).
(Tested in [`InclusionAbleism.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionAbleism.yml).)
- [Cultural sensitivity](#culturally-sensitive-language). - [Cultural sensitivity](#culturally-sensitive-language).
(Tested in [`InclusionCultural.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionCultural.yml).)
We write our developer documentation with inclusivity and diversity in mind. This We write our developer documentation with inclusivity and diversity in mind. This
page is not an exhaustive reference, but describes some general guidelines and page is not an exhaustive reference, but describes some general guidelines and
...@@ -433,11 +436,13 @@ a gender-neutral pronoun. ...@@ -433,11 +436,13 @@ a gender-neutral pronoun.
Avoid the use of gender-specific pronouns, unless referring to a specific person. Avoid the use of gender-specific pronouns, unless referring to a specific person.
<!-- vale gitlab.InclusionGender = NO -->
| Use | Avoid | | Use | Avoid |
|-----------------------------------|---------------------------------| |-----------------------------------|---------------------------------|
| People, humanity | Mankind | | People, humanity | Mankind |
| GitLab Team Members | Manpower | | GitLab Team Members | Manpower |
| You can install; They can install | He can install; She can install | | You can install; They can install | He can install; She can install |
<!-- vale gitlab.InclusionGender = YES -->
If you need to set up [Fake user information](#fake-user-information), use If you need to set up [Fake user information](#fake-user-information), use
diverse or non-gendered names with common surnames. diverse or non-gendered names with common surnames.
...@@ -446,6 +451,7 @@ diverse or non-gendered names with common surnames. ...@@ -446,6 +451,7 @@ diverse or non-gendered names with common surnames.
Avoid terms that are also used in negative stereotypes for different groups. Avoid terms that are also used in negative stereotypes for different groups.
<!-- vale gitlab.InclusionAbleism = NO -->
| Use | Avoid | | Use | Avoid |
|------------------------|----------------------| |------------------------|----------------------|
| Check for completeness | Sanity check | | Check for completeness | Sanity check |
...@@ -454,6 +460,7 @@ Avoid terms that are also used in negative stereotypes for different groups. ...@@ -454,6 +460,7 @@ Avoid terms that are also used in negative stereotypes for different groups.
| Placeholder variable | Dummy variable | | Placeholder variable | Dummy variable |
| Active/Inactive | Enabled/Disabled | | Active/Inactive | Enabled/Disabled |
| On/Off | Enabled/Disabled | | On/Off | Enabled/Disabled |
<!-- vale gitlab.InclusionAbleism = YES -->
Credit: [Avoid ableist language](https://developers.google.com/style/inclusive-documentation#ableist-language) Credit: [Avoid ableist language](https://developers.google.com/style/inclusive-documentation#ableist-language)
in the Google Developer Style Guide. in the Google Developer Style Guide.
...@@ -464,10 +471,12 @@ Avoid terms that reflect negative cultural stereotypes and history. In most ...@@ -464,10 +471,12 @@ Avoid terms that reflect negative cultural stereotypes and history. In most
cases, you can replace terms such as `master` and `slave` with terms that are cases, you can replace terms such as `master` and `slave` with terms that are
more precise and functional, such as `primary` and `secondary`. more precise and functional, such as `primary` and `secondary`.
<!-- vale gitlab.InclusionCultural = NO -->
| Use | Avoid | | Use | Avoid |
|----------------------|-----------------------| |----------------------|-----------------------|
| Primary / secondary | Master / slave | | Primary / secondary | Master / slave |
| Allowlist / denylist | Blacklist / whitelist | | Allowlist / denylist | Blacklist / whitelist |
<!-- vale gitlab.InclusionCultural = YES -->
For more information see the following [Internet Draft specification](https://tools.ietf.org/html/draft-knodel-terminology-02). For more information see the following [Internet Draft specification](https://tools.ietf.org/html/draft-knodel-terminology-02).
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment