summaryrefslogtreecommitdiff
path: root/doc/.vale
diff options
context:
space:
mode:
authorRobert Speicher <rspeicher@gmail.com>2021-01-20 13:34:23 -0600
committerRobert Speicher <rspeicher@gmail.com>2021-01-20 13:34:23 -0600
commit6438df3a1e0fb944485cebf07976160184697d72 (patch)
tree00b09bfd170e77ae9391b1a2f5a93ef6839f2597 /doc/.vale
parent42bcd54d971da7ef2854b896a7b34f4ef8601067 (diff)
downloadgitlab-ce-6438df3a1e0fb944485cebf07976160184697d72.tar.gz
Add latest changes from gitlab-org/gitlab@13-8-stable-eev13.8.0-rc42
Diffstat (limited to 'doc/.vale')
-rw-r--r--doc/.vale/gitlab/Acronyms.yml2
-rw-r--r--doc/.vale/gitlab/Admin.yml2
-rw-r--r--doc/.vale/gitlab/AlertBoxStyle.yml7
-rw-r--r--doc/.vale/gitlab/British.yml2
-rw-r--r--doc/.vale/gitlab/CurlStringsQuoted.yml4
-rw-r--r--doc/.vale/gitlab/FutureTense.yml3
-rw-r--r--doc/.vale/gitlab/OxfordComma.yml3
-rw-r--r--doc/.vale/gitlab/ReferenceLinks.yml2
-rw-r--r--doc/.vale/gitlab/SentenceSpacing.yml5
-rw-r--r--doc/.vale/gitlab/Spelling.yml3
-rw-r--r--doc/.vale/gitlab/SubstitutionSuggestions.yml6
-rw-r--r--doc/.vale/gitlab/SubstitutionWarning.yml4
-rw-r--r--doc/.vale/gitlab/Substitutions.yml4
-rw-r--r--doc/.vale/gitlab/spelling-exceptions.txt2
14 files changed, 23 insertions, 26 deletions
diff --git a/doc/.vale/gitlab/Acronyms.yml b/doc/.vale/gitlab/Acronyms.yml
index 2c28da972da..481da94c627 100644
--- a/doc/.vale/gitlab/Acronyms.yml
+++ b/doc/.vale/gitlab/Acronyms.yml
@@ -58,6 +58,7 @@ exceptions:
- GPL
- GUI
- HAML
+ - HEAD
- HIPAA
- HTML
- HTTP
@@ -90,6 +91,7 @@ exceptions:
- NGINX
- NOTE
- NPM
+ - NTP
- ONLY
- OWASP
- PAT
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 bdf66236ef2..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"
@@ -17,5 +16,5 @@ nonword: true
scope: raw
raw:
- '(\n *\> *(?:NOTE|WARNING)|'
- - '\n(NOTE):[^\n]|' # Adding "WARNING" here causes a false positive
- - '\n *(?:> )?\**(Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger|warning):.*)' ## Adding "Warning" here causes a false positive
+ - '\n\n(NOTE|WARNING):[^\n]|'
+ - '\n\n *(?:> )?\**(Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger|Warning|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 e9fbabf5ffc..c0bc8c18c93 100644
--- a/doc/.vale/gitlab/CurlStringsQuoted.yml
+++ b/doc/.vale/gitlab/CurlStringsQuoted.yml
@@ -1,7 +1,7 @@
---
-# Warning: gitlab.CurlStringsQuoted
+# 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..ab6658f0943 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
@@ -13,7 +13,7 @@ ignorecase: true
swap:
active user: '"billable user"'
active users: '"billable users"'
- docs: documentation
+ docs: '"documentation"'
once that: '"after that"'
once the: '"after the"'
once you: '"after you"'
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
diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt
index 3d8e9b1ef72..6ce0ced52b3 100644
--- a/doc/.vale/gitlab/spelling-exceptions.txt
+++ b/doc/.vale/gitlab/spelling-exceptions.txt
@@ -45,6 +45,7 @@ backtraces
backtracing
badging
Bamboo
+Bazel
Bitbucket
blockquote
blockquoted
@@ -94,6 +95,7 @@ crosslinking
crosslinks
Crossplane
CrowdIn
+CSV
Dangerfile
datetime
Debian