Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
a15d40ac
Commit
a15d40ac
authored
Sep 25, 2020
by
Amy Qualls (slowly returning after surgery)
Committed by
Evan Read
Sep 25, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Create a test for ableist words
Begin testing for words that are ableist in nature.
parent
57c574fc
Changes
5
Hide whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
57 additions
and
2 deletions
+57
-2
doc/.vale/gitlab/InclusionAbleism.yml
doc/.vale/gitlab/InclusionAbleism.yml
+14
-0
doc/.vale/gitlab/InclusionCultural.yml
doc/.vale/gitlab/InclusionCultural.yml
+16
-0
doc/.vale/gitlab/InclusionGender.yml
doc/.vale/gitlab/InclusionGender.yml
+18
-0
doc/.vale/gitlab/SubstitutionWarning.yml
doc/.vale/gitlab/SubstitutionWarning.yml
+0
-2
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+9
-0
No files found.
doc/.vale/gitlab/InclusionAbleism.yml
0 → 100644
View file @
a15d40ac
---
# 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
doc/.vale/gitlab/InclusionCultural.yml
0 → 100644
View file @
a15d40ac
---
# 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
doc/.vale/gitlab/InclusionGender.yml
0 → 100644
View file @
a15d40ac
---
# 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
doc/.vale/gitlab/SubstitutionWarning.yml
View file @
a15d40ac
...
...
@@ -12,7 +12,6 @@ level: warning
ignorecase
:
true
swap
:
admin
:
administrator
blacklist(ed|ing)?
:
denylist
code base
:
codebase
config
:
configuration
distro
:
distribution
...
...
@@ -20,4 +19,3 @@ swap:
filesystem
:
file system
info
:
information
repo
:
repository
whitelist(ed|ing)?
:
allowlist
doc/development/documentation/styleguide.md
View file @
a15d40ac
...
...
@@ -418,8 +418,11 @@ We strive to create documentation that is inclusive. This section includes
guidance and examples in the following categories:
-
[
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
)
.
(Tested in
[
`InclusionAbleism.yml`
](
https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionAbleism.yml
)
.)
-
[
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
page is not an exhaustive reference, but describes some general guidelines and
...
...
@@ -433,11 +436,13 @@ a gender-neutral pronoun.
Avoid the use of gender-specific pronouns, unless referring to a specific person.
<!-- vale gitlab.InclusionGender = NO -->
| Use | Avoid |
|-----------------------------------|---------------------------------|
| People, humanity | Mankind |
| GitLab Team Members | Manpower |
| 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
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.
<!-- vale gitlab.InclusionAbleism = NO -->
| Use | Avoid |
|------------------------|----------------------|
| Check for completeness | Sanity check |
...
...
@@ -454,6 +460,7 @@ Avoid terms that are also used in negative stereotypes for different groups.
| Placeholder variable | Dummy variable |
| Active/Inactive | Enabled/Disabled |
| On/Off | Enabled/Disabled |
<!-- vale gitlab.InclusionAbleism = YES -->
Credit:
[
Avoid ableist language
](
https://developers.google.com/style/inclusive-documentation#ableist-language
)
in the Google Developer Style Guide.
...
...
@@ -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
more precise and functional, such as
`primary`
and
`secondary`
.
<!-- vale gitlab.InclusionCultural = NO -->
| Use | Avoid |
|----------------------|-----------------------|
| Primary / secondary | Master / slave |
| 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
)
.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment