Commit 0c318356 authored by Amy Qualls's avatar Amy Qualls Committed by Evan Read

Add Vale test for warning-level substitutions

There are some word choices we want to disallow in the future, but
the cleanup to get rid of them requires more time than we can spend
on the entire docset at this time. A moderate approach would be to
create a warning-level (as opposed to error-level) substitution test
for these word pairs, so we can start cleaning out the informal
versions of these words over time. If we focus on cleaning up all
instances of a word and occurrences hit zero, we can move a word
from the warnings file to the errors file.
parent b26e9115
---
# Warns against using common shorthand for terms.
# For substitutions flagged as errors, see Substitutions.yml
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: substitution
message: 'If possible, use "%s" instead of "%s".'
link: https://about.gitlab.com/handbook/communication/#top-misused-terms
level: warning
ignorecase: true
swap:
admin: administrator
config: configuration
distro: distribution
info: information
repo: repository
--- ---
# Checks for use of some of the top misused terms at GitLab. # Checks for use of some of the top misused terms at GitLab.
# For substitutions only flagged as warnings, see SubstitutionWarning.yml
# #
# For a list of all options, see https://errata-ai.github.io/vale/styles/ # For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: substitution extends: substitution
......
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