diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-01-06 00:10:23 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-01-06 00:10:23 +0000 |
commit | bc439e2eed92ed397ac40e5f09a1b36cf42b2c83 (patch) | |
tree | f46e2265a219ee8f430fd40997de499fb9fe57a1 /doc/.vale/gitlab | |
parent | 590189d177dad55b697fd52bd88edfdfcebff30d (diff) | |
download | gitlab-ce-bc439e2eed92ed397ac40e5f09a1b36cf42b2c83.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/.vale/gitlab')
-rw-r--r-- | doc/.vale/gitlab/Admin.yml | 2 | ||||
-rw-r--r-- | doc/.vale/gitlab/AlertBoxStyle.yml | 3 | ||||
-rw-r--r-- | doc/.vale/gitlab/British.yml | 2 | ||||
-rw-r--r-- | doc/.vale/gitlab/CurlStringsQuoted.yml | 2 | ||||
-rw-r--r-- | doc/.vale/gitlab/FutureTense.yml | 3 | ||||
-rw-r--r-- | doc/.vale/gitlab/OxfordComma.yml | 3 | ||||
-rw-r--r-- | doc/.vale/gitlab/ReferenceLinks.yml | 2 | ||||
-rw-r--r-- | doc/.vale/gitlab/SentenceSpacing.yml | 5 | ||||
-rw-r--r-- | doc/.vale/gitlab/Spelling.yml | 3 | ||||
-rw-r--r-- | doc/.vale/gitlab/SubstitutionSuggestions.yml | 4 | ||||
-rw-r--r-- | doc/.vale/gitlab/SubstitutionWarning.yml | 4 | ||||
-rw-r--r-- | doc/.vale/gitlab/Substitutions.yml | 4 |
12 files changed, 15 insertions, 22 deletions
diff --git a/doc/.vale/gitlab/Admin.yml b/doc/.vale/gitlab/Admin.yml index 6d01882138a..96325ad2ef4 100644 --- a/doc/.vale/gitlab/Admin.yml +++ b/doc/.vale/gitlab/Admin.yml @@ -1,7 +1,7 @@ --- # Warning: gitlab.Admin # -# You should not use "admin", but "Admin Area" is OK. +# Checks for "admin" and recommends using the full word instead. "Admin Area" is OK. # # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: substitution diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml index 78db7fa99ae..92c3a16cab8 100644 --- a/doc/.vale/gitlab/AlertBoxStyle.yml +++ b/doc/.vale/gitlab/AlertBoxStyle.yml @@ -1,9 +1,8 @@ --- # Error: gitlab.AlertBoxStyle # -# Makes sure alert boxes are used with block quotes. +# Makes sure alert boxes are used with block quotes. Checks for 3 formatting issues: # -# Checks for 3 formatting issues: # - Alert boxes inside a block quote (">") # - Alert boxes with the note text on the same line # - Alert boxes using words other than "NOTE" or "WARNING" diff --git a/doc/.vale/gitlab/British.yml b/doc/.vale/gitlab/British.yml index 65842ad7aa5..152723ead26 100644 --- a/doc/.vale/gitlab/British.yml +++ b/doc/.vale/gitlab/British.yml @@ -1,7 +1,7 @@ --- # Error: gitlab.British # -# Checks that US spelling is used over British spelling. +# Checks that US spelling is used instead of British spelling. # # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: substitution diff --git a/doc/.vale/gitlab/CurlStringsQuoted.yml b/doc/.vale/gitlab/CurlStringsQuoted.yml index 32bf662f2ae..c0bc8c18c93 100644 --- a/doc/.vale/gitlab/CurlStringsQuoted.yml +++ b/doc/.vale/gitlab/CurlStringsQuoted.yml @@ -1,7 +1,7 @@ --- # Error: gitlab.CurlStringsQuoted # -# Ensures all code blocks using curl quote any URL strings. +# Ensures all code blocks using `curl` wrap URL strings in quotation marks. # # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence diff --git a/doc/.vale/gitlab/FutureTense.yml b/doc/.vale/gitlab/FutureTense.yml index d7001d57899..fc414a9c0fd 100644 --- a/doc/.vale/gitlab/FutureTense.yml +++ b/doc/.vale/gitlab/FutureTense.yml @@ -1,8 +1,7 @@ --- # Suggestion: gitlab.FutureTense # -# Checks for use of future tense in sentences. Present tense is preferred as -# much as possible. +# Checks for use of future tense in sentences. Present tense is strongly preferred. # # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence diff --git a/doc/.vale/gitlab/OxfordComma.yml b/doc/.vale/gitlab/OxfordComma.yml index 0425d9e1dd0..1716145b26a 100644 --- a/doc/.vale/gitlab/OxfordComma.yml +++ b/doc/.vale/gitlab/OxfordComma.yml @@ -1,8 +1,7 @@ --- # Warning: gitlab.OxfordComma # -# Checks for the lack of an Oxford comma. In some cases, will catch overly -# complex sentence structures with lots of commas. +# Checks for the lack of an Oxford comma. In some cases, will catch overly complex sentence structures with lots of commas. # # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence diff --git a/doc/.vale/gitlab/ReferenceLinks.yml b/doc/.vale/gitlab/ReferenceLinks.yml index 0df1f359107..160ed2e8e14 100644 --- a/doc/.vale/gitlab/ReferenceLinks.yml +++ b/doc/.vale/gitlab/ReferenceLinks.yml @@ -1,7 +1,7 @@ --- # Error: gitlab.ReferenceLinks # -# Checks for the presence of reference-style links that must be inline. +# Checks for reference-style links that should be converted to inline links. # # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence diff --git a/doc/.vale/gitlab/SentenceSpacing.yml b/doc/.vale/gitlab/SentenceSpacing.yml index 884d4b57508..0288abe834f 100644 --- a/doc/.vale/gitlab/SentenceSpacing.yml +++ b/doc/.vale/gitlab/SentenceSpacing.yml @@ -1,10 +1,7 @@ --- # Error: gitlab.SentenceSpacing # -# Checks for the following in common content scenarios: -# -# - No spaces. -# - More than one space. +# Checks for incorrect spacing (no spaces, or more than one space) around punctuation. # # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence diff --git a/doc/.vale/gitlab/Spelling.yml b/doc/.vale/gitlab/Spelling.yml index 602b7cd11e6..4ebaf7bfb70 100644 --- a/doc/.vale/gitlab/Spelling.yml +++ b/doc/.vale/gitlab/Spelling.yml @@ -1,8 +1,7 @@ --- # Warning: gitlab.Spelling # -# Checks for possible spelling mistakes in content, not code. May find false positives -# due to links using angle brackets: <https://example.com>. These can be ignored. +# Checks for possible spelling mistakes in content, not code. Results from links using angle brackets (<https://example.com>) should be corrected. # # If a word is flagged as a spelling mistake incorrectly, such as a product name, # you can submit an MR to update `spelling-exceptions.txt` with the missing word. diff --git a/doc/.vale/gitlab/SubstitutionSuggestions.yml b/doc/.vale/gitlab/SubstitutionSuggestions.yml index 82e3e789864..735a39119d7 100644 --- a/doc/.vale/gitlab/SubstitutionSuggestions.yml +++ b/doc/.vale/gitlab/SubstitutionSuggestions.yml @@ -1,8 +1,8 @@ --- # Suggestion: gitlab.SubstitutionSuggestions # -# Suggests better options for frequently misused terms at GitLab that are -# often - but not always - incorrect. +# 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 diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml index ed0f8b498fe..61fd0148fd8 100644 --- a/doc/.vale/gitlab/SubstitutionWarning.yml +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -1,8 +1,8 @@ --- # Warning: gitlab.SubstitutionWarning # -# Warns against using common shorthand for terms. -# For substitutions flagged as errors, see Substitutions.yml +# Checks for misused terms or common shorthand that should never be used at GitLab, but can't be flagged as errors. +# Substitutions.yml and SubstitionSuggestions.yml also exist. # # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: substitution diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index 0a56524e3f5..987785c7a22 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -1,8 +1,8 @@ --- # Error: gitlab.Substitutions # -# Checks for use of some of the top misused terms at GitLab. -# For substitutions only flagged as warnings, see SubstitutionWarning.yml +# Checks for misused terms that should never be used at GitLab. +# SubstitutionWarning.yml and SubstitionSuggestions.yml also exist. # # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: substitution |