Skip to content
Snippets Groups Projects
Commit 17769a9a authored by Evan Read's avatar Evan Read
Browse files

Harmonize docs linting rules

parent 52f5c2f4
No related branches found
No related tags found
No related merge requests found
Loading
Loading
@@ -45,9 +45,11 @@
"Debian",
"DevOps",
"Docker",
"DockerSlim",
"Elasticsearch",
"Facebook",
"fastlane",
"fluent-plugin-redis-slowlog",
"GDK",
"Geo",
"Git LFS",
Loading
Loading
Loading
Loading
@@ -76,6 +76,7 @@ exceptions:
- SCSS
- SDK
- SHA
- SLA
- SMTP
- SQL
- SSH
Loading
Loading
Loading
Loading
@@ -3,6 +3,12 @@
#
# Makes sure alert boxes follow standard formatting.
#
# Checks for 4 known issues:
# - Alert boxes with no colon, or colon outside the bold text
# - Known incorrect capitalization of the most commonly used alert box text
# - Alert boxes with the note text on the same line
# - Alert boxes using blockquote formatting, like "> **Note:**"
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: existence
message: 'Alert box "%s" must use the formatting in the style guide.'
Loading
Loading
Loading
Loading
@@ -67,7 +67,6 @@ swap:
matt: matte
meagre: meager
metre: meter
mitre: miter
modelling: modeling
moustache: mustache
neighbour: neighbor
Loading
Loading
---
# 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
---
# 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
---
# 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
Loading
Loading
@@ -12,7 +12,6 @@ level: warning
ignorecase: true
swap:
admin: administrator
blacklist(ed|ing)?: denylist
code base: codebase
config: configuration
distro: distribution
Loading
Loading
@@ -20,4 +19,3 @@ swap:
filesystem: file system
info: information
repo: repository
whitelist(ed|ing)?: allowlist
Loading
Loading
@@ -76,6 +76,7 @@ Citus
clonable
Cloudwatch
Cobertura
Codepen
Cognito
colocated
colocating
Loading
Loading
@@ -283,6 +284,7 @@ namespaces
namespacing
namespacings
Nanoc
Netlify
NGINX
Nokogiri
npm
Loading
Loading
@@ -296,6 +298,7 @@ OmniAuth
onboarding
OpenID
OpenShift
Opsgenie
Packagist
parallelization
parallelizations
Loading
Loading
@@ -380,6 +383,7 @@ reusability
reverified
reverifies
reverify
RHEL
rollout
rollouts
rsync
Loading
Loading
@@ -402,6 +406,7 @@ sanitization
sbt
scatterplot
scatterplots
Schemastore
Sendmail
Sentry
serializer
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment