diff options
Diffstat (limited to 'doc/.vale')
| -rw-r--r-- | doc/.vale/gitlab/Acronyms.yml | 2 | ||||
| -rw-r--r-- | doc/.vale/gitlab/Admin.yml | 13 | ||||
| -rw-r--r-- | doc/.vale/gitlab/InclusionAbleism.yml | 14 | ||||
| -rw-r--r-- | doc/.vale/gitlab/InclusionCultural.yml | 16 | ||||
| -rw-r--r-- | doc/.vale/gitlab/InclusionGender.yml | 18 | ||||
| -rw-r--r-- | doc/.vale/gitlab/OutdatedVersions.yml | 2 | ||||
| -rw-r--r-- | doc/.vale/gitlab/SubstitutionWarning.yml | 3 | ||||
| -rw-r--r-- | doc/.vale/gitlab/Substitutions.yml | 1 | ||||
| -rw-r--r-- | doc/.vale/gitlab/spelling-exceptions.txt | 24 |
9 files changed, 89 insertions, 4 deletions
diff --git a/doc/.vale/gitlab/Acronyms.yml b/doc/.vale/gitlab/Acronyms.yml index d26ce9810d7..53690138300 100644 --- a/doc/.vale/gitlab/Acronyms.yml +++ b/doc/.vale/gitlab/Acronyms.yml @@ -44,6 +44,7 @@ exceptions: - IBM - IDE - IID + - IMAP - IRC - ISO - JSON @@ -65,6 +66,7 @@ exceptions: - POST - PUT - RAM + - REST - RPC - RSA - RSS diff --git a/doc/.vale/gitlab/Admin.yml b/doc/.vale/gitlab/Admin.yml new file mode 100644 index 00000000000..27a703c30c3 --- /dev/null +++ b/doc/.vale/gitlab/Admin.yml @@ -0,0 +1,13 @@ +--- +# Warning: gitlab.Admin +# +# You should not use "admin", but "Admin Area" is OK. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: substitution +message: 'Use "administration", "administrator", "administer", or "Admin Area" instead of "admin" or "admin area".' +link: https://docs.gitlab.com/ee/development/documentation/styleguide.html +level: warning +ignorecase: true +swap: + 'admin ?\w*': '(?:Admin Area|[Aa]dminist(ration|rator|er))' diff --git a/doc/.vale/gitlab/InclusionAbleism.yml b/doc/.vale/gitlab/InclusionAbleism.yml new file mode 100644 index 00000000000..29b26547130 --- /dev/null +++ b/doc/.vale/gitlab/InclusionAbleism.yml @@ -0,0 +1,14 @@ +--- +# 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, sample, fake diff --git a/doc/.vale/gitlab/InclusionCultural.yml b/doc/.vale/gitlab/InclusionCultural.yml new file mode 100644 index 00000000000..5bfad84f100 --- /dev/null +++ b/doc/.vale/gitlab/InclusionCultural.yml @@ -0,0 +1,16 @@ +--- +# 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, main + slave: secondary diff --git a/doc/.vale/gitlab/InclusionGender.yml b/doc/.vale/gitlab/InclusionGender.yml new file mode 100644 index 00000000000..389d76d7a24 --- /dev/null +++ b/doc/.vale/gitlab/InclusionGender.yml @@ -0,0 +1,18 @@ +--- +# 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 diff --git a/doc/.vale/gitlab/OutdatedVersions.yml b/doc/.vale/gitlab/OutdatedVersions.yml index 1bc0bf58f90..2ce61ee5798 100644 --- a/doc/.vale/gitlab/OutdatedVersions.yml +++ b/doc/.vale/gitlab/OutdatedVersions.yml @@ -7,7 +7,7 @@ extends: existence message: 'Can this reference to "%s" be refactored?' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#importance-of-referencing-gitlab-versions-and-tiers -level: warning +level: suggestion nonword: true ignorecase: true tokens: diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml index 5324a48e38c..68313a37e7d 100644 --- a/doc/.vale/gitlab/SubstitutionWarning.yml +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -11,8 +11,6 @@ link: https://about.gitlab.com/handbook/communication/#top-misused-terms level: warning ignorecase: true swap: - admin: administrator - blacklist(ed|ing)?: denylist code base: codebase config: configuration distro: distribution @@ -20,4 +18,3 @@ swap: filesystem: file system info: information repo: repository - whitelist(ed|ing)?: allowlist diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index 77536ea0b33..704c64f1fbd 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -13,6 +13,7 @@ ignorecase: true swap: frontmatter: front matter GitLabber: GitLab team member + GitLab-shell: GitLab Shell gitlab omnibus: Omnibus GitLab param: parameter params: parameters diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt index bf816afdfab..c0a85fc6b70 100644 --- a/doc/.vale/gitlab/spelling-exceptions.txt +++ b/doc/.vale/gitlab/spelling-exceptions.txt @@ -61,6 +61,7 @@ buildpacks bundler bundlers burndown +burnup cacheable CAS CentOS @@ -142,8 +143,10 @@ Facebook failover failovers failsafe +Falco fastlane favicon +Figma Filebeat Fio firewalled @@ -166,6 +169,7 @@ Gitleaks Gitter globals Gmail +Gollum Google Gosec Gradle @@ -220,6 +224,7 @@ Kibana Kinesis Knative Kramdown +Kubecost kubectl Kubernetes Kubesec @@ -253,6 +258,7 @@ memoize memoized memoizing Memorystore +mergeability mergeable Microsoft middleware @@ -275,6 +281,7 @@ mockups ModSecurity monorepo monorepos +multiline mutex nameserver nameservers @@ -298,6 +305,7 @@ OmniAuth onboarding OpenID OpenShift +Opsgenie Packagist parallelization parallelizations @@ -305,6 +313,7 @@ passwordless Patroni performant PgBouncer +Phabricator phaser phasers Pipfile @@ -345,6 +354,7 @@ Python Qualys Rackspace Raspbian +Rdoc reachability rebase rebased @@ -365,6 +375,8 @@ reindex reindexed reindexes reindexing +reinitialize +reinitializing relicensing remediations repmgr @@ -382,6 +394,7 @@ reusability reverified reverifies reverify +RHEL rollout rollouts rsync @@ -423,7 +436,10 @@ smartcard smartcards SMTP Sobelow +Solarized Sourcegraph +sparkline +sparklines spidering Splunk SpotBugs @@ -439,6 +455,8 @@ subfolder subfolders subgraph subgraphs +subkey +subkeys sublicense sublicensed sublicenses @@ -455,8 +473,10 @@ substring substrings subtree subtrees +sudo syslog tcpdump +Thanos Tiller timecop todos @@ -479,6 +499,7 @@ unarchived unarchives unarchiving unassign +unassigning unassigns uncheck unchecked @@ -510,6 +531,9 @@ unprioritized unprotect unprotected unprotects +unprovision +unprovisioned +unprovisions unpublish unpublished unpublishes |