init

doc/.vale/gitlab/GitLabFlavoredMarkdown.yml

+---
+# Warning: gitlab.GitLabFlavoredMarkdown
+#
+# Checks for unclear use of GLFM or GLM instead of GitLab/GitHub Flavored Markdown
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: substitution
+message: "Use '%s' instead of '%s' when possible."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
+level: warning
+ignorecase: true
+swap:
+  GLFM: "GitLab Flavored Markdown"
+  GFM: "GitLab Flavored Markdown' or 'GitHub Flavored Markdown"

doc/.vale/gitlab/HeadingContent.yml

+---
+# Warning: gitlab.HeadingContent
+#
+# Checks for generic, unhelpful subheadings.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Rename the heading '%s', or re-purpose the content elsewhere."
+level: warning
+link: https://docs.gitlab.com/ee/development/documentation/topic_types/concept.html#concept-topic-titles
+ignorecase: true
+nonword: true
+scope: raw
+tokens:
+  - '\#+ How it works'
+  - '\#+ Limitations'
+  - '\#+ Overview'
+  - '\#+ Use cases?'
+  - '\#+ Important notes?'

doc/.vale/gitlab/HeadingDepth.yml

+---
+# Suggestion: gitlab.HeadingDepth
+#
+# Checks that there are no headings greater than 3 levels
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Refactor the section or page to avoid headings greater than H5."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#heading-levels-in-markdown
+level: suggestion
+scope: raw
+raw:
+  - '(?<=\n)#{6,}\s.*'

doc/.vale/gitlab/HistoryItems.yml

+---
+# Warning: gitlab.HistoryItems
+#
+# Ensures history items are properly formatted.
+#
+extends: existence
+message: "History items must always start with '> -', one item per line, even if there is only one item."
+link: https://docs.gitlab.com/ee/development/documentation/versions.html#add-a-version-history-item
+level: error
+scope: raw
+raw:
+  - '(?m)(?<=^#+[^\n]*\n\n)> [^-]|'
+  - '^> - [^\n]*\n[^\n>`]'

doc/.vale/gitlab/HistoryItemsOrder.yml

+---
+# Warning: gitlab.HistoryItemsOrder
+#
+# Ensures history items come before the Details block.
+#
+extends: existence
+message: "History items must follow the tier, offering, or status details."
+link: https://docs.gitlab.com/ee/development/documentation/versions.html#add-a-version-history-item
+level: error
+scope: raw
+raw:
+  - '(?m)^\>[^\n]*\n\nDETAILS'

doc/.vale/gitlab/InclusionAbleism.yml

+---
+# Warning: gitlab.InclusionAbleism
+#
+# Suggests alternatives for words that foster ableism.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: substitution
+message: "Use inclusive language. Consider '%s' instead of '%s'."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
+level: warning
+ignorecase: true
+swap:
+  sanity (?:check|test): check for completeness
+  dummy: placeholder, sample, fake

doc/.vale/gitlab/InclusionCultural.yml

+---
+# Warning: gitlab.InclusionCultural
+#
+# Suggests alternatives for words that are culturally inappropriate.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: substitution
+message: "Use inclusive language. Consider '%s' instead of '%s'."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
+level: warning
+ignorecase: true
+swap:
+  blacklist(?:ed|ing|s)?: denylist
+  whitelist(?:ed|ing|s)?: allowlist
+  master: primary, main
+  slave: secondary

doc/.vale/gitlab/InclusionGender.yml

+---
+# Warning: gitlab.InclusionGender
+#
+# Suggests alternatives for words that are gender-specific.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: substitution
+message: "Use inclusive language. Consider '%s' instead of '%s'."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
+level: warning
+ignorecase: true
+swap:
+  mankind: humanity, people
+  manpower: GitLab team members
+  he: they
+  his: their
+  she: they
+  hers: their

doc/.vale/gitlab/InternalLinkCase.yml

+---
+# Error: gitlab.InternalLinkCase
+#
+# Checks that anchor fragments on internal links are in lower-case.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Use lowercase for the anchor link."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#anchor-links
+level: error
+scope: raw
+raw:
+  - '[^\`]\[[^\[\]]+\]\((https?:){0}[\w\/\.]*?#[^\s]*?[A-Z][^\) ]*\)[^\`]'

doc/.vale/gitlab/InternalLinkExtension.yml

+---
+# Error: gitlab.InternalLinkExtension
+#
+# Checks that internal links have .md extenstion and not .html extension.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Link to a file and use the .md file extension instead of .html."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links
+level: error
+scope: raw
+raw:
+  - '\[[^\]]+\]\([^:\)]+(\/(#[^\)]+)?\)|\.html(#.+)?\))'

doc/.vale/gitlab/InternalLinkFormat.yml

+---
+# Error: gitlab.InternalLinkFormat
+#
+# Checks that internal link paths don't start with '/' or './'.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Edit the link so it does not start with '/' or './'."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links
+level: error
+scope: raw
+raw:
+  - '\[[^\]]+\]\(\.?\/(?!uploads|documentation).*?\)'

doc/.vale/gitlab/LatinTerms.yml

+---
+# Warning: gitlab.LatinTerms
+#
+# Checks for use of Latin terms.
+# Uses https://github.com/errata-ai/Google/blob/master/Google/Latin.yml for ideas.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: substitution
+message: "Use '%s' instead of '%s', but consider rewriting the sentence."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
+level: warning
+nonword: true
+ignorecase: true
+swap:
+  '\b(?:e\.?g[\s.,;:])': for example
+  '\b(?:i\.?e[\s.,;:])': that is
+  '\bvia\b': "with', 'through', or 'by using"

doc/.vale/gitlab/Level.yml

+---
+# Suggestion: gitlab.Level
+#
+# Avoid variations on the phrase "instance level" and "group level"
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Avoid using 'level' when referring to groups, instances, or projects: '%s'"
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#level
+level: suggestion
+ignorecase: true
+tokens:
+  - 'instance level'
+  - 'instance-level'
+  - 'group level'
+  - 'group-level'
+  - 'project level'
+  - 'project-level'

doc/.vale/gitlab/MeaningfulLinkWords.yml

+---
+# Warning: gitlab.MeaningfulLinkWords
+#
+# Checks for the presence of semantically unhelpful words in link text.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Improve SEO and accessibility by rewriting the link text for '%s'."
+level: warning
+ignorecase: true
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#text-for-links
+scope: raw
+nonword: true
+tokens:
+  - '\[here\](?=\(.*\))'
+  - '\[this\](?=\(.*\))'
+  - '\[this page\](?=\(.*\))'

doc/.vale/gitlab/MergeConflictMarkers.yml

+---
+# Error: gitlab.MergeConflictMarkers
+#
+# Checks for the presence of merge conflict markers.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Remove the merge conflict marker '%s'."
+link: https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-request
+level: error
+scope: raw
+raw:
+  - '\n<<<<<<< .+\n|\n=======\n|\n>>>>>>> .+\n'

doc/.vale/gitlab/MultiLineLinks.yml

+---
+# Error: gitlab.MultiLineLinks
+#
+# Checks that links are all on a single line.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Put the full link on one line, even if the link is very long."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links
+level: error
+scope: raw
+raw:
+  - '\[[^\[\]]*?\n[^\[\]]*?\]\([^\)]*?\)|'
+  - '\[[^\[\]]*?\]\([^\)]*?\n[^\)]*\)'

doc/.vale/gitlab/NonStandardQuotes.yml

+---
+# Warning: gitlab.NonStandardQuotes
+#
+# Use only standard single and double quotes, not left or right quotes.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Use standard single quotes or double quotes only. Do not use left or right quotes."
+level: warning
+ignorecase: true
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation
+scope: raw
+raw:
+  - '[‘’“”]'

doc/.vale/gitlab/Normal.yml

+---
+# Warning: gitlab.Normal
+#
+# Suggests alternatives for 'normal'.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: substitution
+message: "Use '%s' instead of '%s'."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
+level: warning
+ignorecase: true
+swap:
+  normally: "usually' or 'typically"
+  normal:  "typical' or 'standard"

doc/.vale/gitlab/OutdatedVersions.yml

+---
+# Suggestion: gitlab.OutdatedVersions
+#
+# Checks for references to versions of GitLab that are no longer supported.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "If possible, remove the reference to '%s'."
+link: https://docs.gitlab.com/ee/development/documentation/versions.html
+level: suggestion
+nonword: true
+ignorecase: true
+tokens:
+  - "GitLab (v)?2."
+  - "GitLab (v)?3."
+  - "GitLab (v)?4."
+  - "GitLab (v)?5."
+  - "GitLab (v)?6."
+  - "GitLab (v)?7."
+  - "GitLab (v)?8."
+  - "GitLab (v)?9."
+  - "GitLab (v)?10."
+  - "GitLab (v)?11."
+  - "GitLab (v)?12."
+  - "GitLab (v)?13."
+  - "GitLab (v)?14."

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://vale.sh/docs/topics/styles/
+extends: existence
+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/index.html#punctuation
+level: warning
+raw:
+  - '(?:[\w-_` ]+,){2,}(?:[\w-_` ]+) (and |or )'