gitlab-org--gitlab-foss/doc/.vale/gitlab/SubstitutionSuggestions.yml

27 lines
875 B
YAML

---
# Suggestion: gitlab.SubstitutionSuggestions
#
# Suggests better options for frequently misused terms that are often - but not always - incorrect.
# SubstitutionWarning.yml and Substitutions.yml also exist.
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: substitution
message: 'Consider %s instead of "%s".'
link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language
level: suggestion
ignorecase: true
swap:
active user: '"billable user"'
active users: '"billable users"'
docs: '"documentation"'
e-mail: '"email"'
GFM: '"GitLab Flavored Markdown"'
it is recommended: '"we recommend"'
OAuth2: '"OAuth 2.0"'
once that: '"after that"'
once the: '"after the"'
once you: '"after you"'
since: '"because" or "after"'
sub-group: '"subgroup"'
sub-groups: '"subgroups"'
within: '"in"'