Merge branch 'eread/consistent-vale-config-rules' into 'master'

Make Vale rule configuration follow a pattern

See merge request gitlab-org/gitlab!34131

doc/.vale/gitlab/Acronyms.yml

+---
+# Warning: gitlab.Acronyms
+#
 # Checks for unexpanded acronyms.
 #
 # For a list of all options, see https://errata-ai.github.io/vale/styles/
 extends: conditional
-message: "'%s' has no definition."
+message: '"%s" has no definition.'
 link: https://about.gitlab.com/handbook/marketing/growth-marketing/content/editorial-team/#acronyms
 level: warning
 ignorecase: false
@@ -60,4 +63,3 @@ exceptions:
   - WIP
   - XML
   - YAML
-  

doc/.vale/gitlab/BadgeCapitalization.yml

 ---
 # Error: gitlab.BadgeCapitalization
 #
-# Verifies that badges are not lower case, which won't render properly.
+# Verifies that badges are not mixed case, which won't render properly.
 #
 # For a list of all options, see https://errata-ai.github.io/vale/styles/
 extends: existence

doc/.vale/gitlab/British.yml

 ---
 # Error: gitlab.British
 #
-# Checks for use of some of the top misused terms at GitLab.
+# Checks that US spelling is used over British spelling.
 #
 # For a list of all options, see https://errata-ai.github.io/vale/styles/
 extends: substitution
-message: 'Use the American spelling "%s" instead of the British "%s".'
+message: 'Use the US spelling "%s" instead of the British "%s".'
 link: https://about.gitlab.com/handbook/communication/#top-misused-terms
 level: error
 ignorecase: true

doc/.vale/gitlab/CodeblockFences.yml

 ---
 # Error: gitlab.CodeblockFences
 #
-# Ensures all codeblock fences use the full name for the language.
+# Ensures all codeblock language tags use the full name, not aliases.
 #
 # For a list of all options, see https://errata-ai.github.io/vale/styles/
 extends: existence

doc/.vale/gitlab/Contractions.yml

 ---
+# Suggestion: gitlab.Contractions
+#
 # Checks for use of common and uncommon contractions.
 #
 # For a list of all options, see https://errata-ai.github.io/vale/styles/
 extends: substitution
-message: Use "%s" instead of "%s", for a friendly, informal tone.
+message: 'Use "%s" instead of "%s", for a friendly, informal tone.'
 link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
 level: suggestion
 nonword: false

doc/.vale/gitlab/CurlStringsQuoted.yml

 ---
-# Error: gitlab.CurlStringsQuoted
+# Warning: gitlab.CurlStringsQuoted
 #
 # Ensures all codeblocks using curl quote any URL strings.
 #

doc/.vale/gitlab/FirstPerson.yml

+---
+# Warning: gitlab.FirstPerson
+#
 # Checks for use of first person pronouns.
 #
 # For a list of all options, see https://errata-ai.github.io/vale/styles/
 extends: existence
-message: '`%s` is a first-person pronoun. Use second- or third-person pronouns (like we, you, us, one) instead.'
+message: '"%s" is a first-person pronoun. Use second- or third-person pronouns (like we, you, us, one) instead.'
 level: warning
 ignorecase: true
 link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language

doc/.vale/gitlab/InternalLinkExtension.yml

@@ -5,7 +5,7 @@
 #
 # For a list of all options, see https://errata-ai.github.io/vale/styles/
 extends: existence
-message: Link %s must use the .md file extension.
+message: 'Link "%s" must use the .md file extension.'
 link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation
 level: error
 scope: raw

doc/.vale/gitlab/LatinTerms.yml

 ---
-# Checks for use of latin terms..
+# Warning: gitlab.LatinTerms
+#
+# Checks for use of latin terms.
 #
 # For a list of all options, see https://errata-ai.github.io/vale/styles/
 extends: substitution
-message: Use "%s" instead of "%s," but consider rewriting the sentence.
+message: 'Use "%s" instead of "%s", but consider rewriting the sentence.'
 link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
 level: warning
 nonword: true

doc/.vale/gitlab/MeaningfulLinkWords.yml

 ---
-# Error: gitlab.MeaningfulLinkWords
+# Warning: gitlab.MeaningfulLinkWords
 #
 # Checks for the presence of semantically unhelpful words in link text.
 #

doc/.vale/gitlab/OxfordComma.yml

 ---
+# Warning: gitlab.OxfordComma
+#
 # 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.github.io/vale/styles/
 extends: existence
-message: Use a comma before the last "and" or "or" in a list of four or more items.
+message: 'Use a comma before the last "and" or "or" in a list of four or more items.'
 link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#punctuation
 level: warning
 raw:

doc/.vale/gitlab/RelativeLinks.yml

@@ -5,7 +5,7 @@
 #
 # For a list of all options, see https://errata-ai.github.io/vale/styles/
 extends: existence
-message: Link %s must be relative.
+message: 'Link "%s" must be relative.'
 link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation
 level: error
 scope: raw

doc/.vale/gitlab/SentenceLength.yml

 ---
+# Warning: gitlab.SentenceLength
+#
 # Counts words in a sentence and alerts if a sentence exceeds 25 words.
 #
 # For a list of all options, see https://errata-ai.github.io/vale/styles/
 extends: occurrence
-message: "Shorter sentences improve readability (max 25 words)."
+message: 'Shorter sentences improve readability (max 25 words).'
 scope: sentence
 link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
 level: warning

doc/.vale/gitlab/Spelling.yml

+---
+# 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.
 #

doc/.vale/gitlab/SubstitutionWarning.yml

 ---
+# Warning: gitlab.SubstitutionWarning
+#
 # Warns against using common shorthand for terms.
 # For substitutions flagged as errors, see Substitutions.yml
 #