diff options
Diffstat (limited to 'doc/.vale')
26 files changed, 112 insertions, 35 deletions
diff --git a/doc/.vale/gitlab/Acronyms.yml b/doc/.vale/gitlab/Acronyms.yml index 5176a18e2b6..d166e71491c 100644 --- a/doc/.vale/gitlab/Acronyms.yml +++ b/doc/.vale/gitlab/Acronyms.yml @@ -3,7 +3,7 @@ # # Checks for unexpanded acronyms. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: conditional message: '"%s" has no definition.' link: https://about.gitlab.com/handbook/marketing/growth-marketing/content/editorial-team/#acronyms @@ -18,12 +18,15 @@ exceptions: - ARN - ASCII - AWS + - CLI - CNAME - CPU + - CORE - CSS - CSV - DNS - EKS + - FAQ - GDK - GET - GNU @@ -33,21 +36,28 @@ exceptions: - HTTP - HTTPS - IAM + - IBM - IDE + - IRC + - ISO - JSON - LDAP - LDAPS - LESS - LFS + - LRU - NFS - NGINX - NOTE + - NPM - ONLY + - PDF - PGP - PHP - POST - PUT - RPC + - RAM - RSA - RSS - SAML @@ -58,13 +68,17 @@ exceptions: - SSH - SSL - SSO + - SVN + - TCP - TIP - TLS - TODO - TOML - UNIX + - USB - URI - URL + - UUID - VPC - WIP - XML diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml new file mode 100644 index 00000000000..831d5395fc8 --- /dev/null +++ b/doc/.vale/gitlab/AlertBoxStyle.yml @@ -0,0 +1,16 @@ +--- +# Error: gitlab.AlertBoxStyle +# +# Makes sure alert boxes follow standard formatting. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Alert box "%s" must use the formatting detailed in the documentation style guide.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes +level: error +scope: raw +raw: + - '((NOTE|TIP|CAUTION|DANGER): \*\*[^:]*\*\*)|' + - '((NOTE: \*\*NOTE:\*\*)|(TIP: \*\*TIP:\*\*)|(CAUTION: \*\*CAUTION:\*\*)|(DANGER: \*\*DANGER:\*\*))|' + - '((NOTE: \*\*note:\*\*)|(TIP: \*\*tip:\*\*)|(CAUTION: \*\*caution:\*\*)|(DANGER: \*\*danger:\*\*))|' + - '((NOTE|TIP|CAUTION|DANGER): \*\*.*\*\*.+)' diff --git a/doc/.vale/gitlab/BadgeCapitalization.yml b/doc/.vale/gitlab/BadgeCapitalization.yml index c9e9da3b6ce..caf7143e254 100644 --- a/doc/.vale/gitlab/BadgeCapitalization.yml +++ b/doc/.vale/gitlab/BadgeCapitalization.yml @@ -3,7 +3,7 @@ # # 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/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: 'Badge "%s" must be capitalized.' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#product-badges diff --git a/doc/.vale/gitlab/British.yml b/doc/.vale/gitlab/British.yml index 1e5841d3648..3a0cb321f93 100644 --- a/doc/.vale/gitlab/British.yml +++ b/doc/.vale/gitlab/British.yml @@ -3,7 +3,7 @@ # # Checks that US spelling is used over British spelling. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: substitution message: 'Use the US spelling "%s" instead of the British "%s".' link: https://about.gitlab.com/handbook/communication/#top-misused-terms diff --git a/doc/.vale/gitlab/CodeblockFences.yml b/doc/.vale/gitlab/CodeblockFences.yml index 8b61a1a3c16..7258a8ef475 100644 --- a/doc/.vale/gitlab/CodeblockFences.yml +++ b/doc/.vale/gitlab/CodeblockFences.yml @@ -3,7 +3,7 @@ # # 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/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: 'Syntax highlighting hint "%s" must be one of: yaml, ruby, plaintext, markdown, javascript, shell, golang, python, dockerfile, or typescript.' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#code-blocks diff --git a/doc/.vale/gitlab/Contractions.yml b/doc/.vale/gitlab/Contractions.yml index 45212945c53..dc48b876f40 100644 --- a/doc/.vale/gitlab/Contractions.yml +++ b/doc/.vale/gitlab/Contractions.yml @@ -3,7 +3,7 @@ # # Checks for use of common and uncommon contractions. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: substitution message: 'Use "%s" instead of "%s", for a friendly, informal tone.' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language @@ -20,7 +20,6 @@ swap: have not: haven't that is: that's we are: we're - will not: won't would not: wouldn't you are: you're you have: you've @@ -31,25 +30,16 @@ swap: didn't: did not doesn't: does not hasn't: has not - how'll: how will how's: how is isn't: is not - it'll: it will shouldn't: should not - that'll: that will - they'll: they will they're: they are wasn't: was not weren't: were not - we'll: we will we've: we have what's: what is - what'll: what will when's: when is - when'll: when will where's: where is - where'll: where will who's: who is - who'll: who will why's: why is - why'll: why will + diff --git a/doc/.vale/gitlab/CurlStringsQuoted.yml b/doc/.vale/gitlab/CurlStringsQuoted.yml index 4fcb0069423..39ee9372947 100644 --- a/doc/.vale/gitlab/CurlStringsQuoted.yml +++ b/doc/.vale/gitlab/CurlStringsQuoted.yml @@ -3,7 +3,7 @@ # # Ensures all codeblocks using curl quote any URL strings. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: 'Curl commands must wrap URLs in double quotes ("): %s' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#curl-commands diff --git a/doc/.vale/gitlab/CurrentStatus.yml b/doc/.vale/gitlab/CurrentStatus.yml new file mode 100644 index 00000000000..7368310eee8 --- /dev/null +++ b/doc/.vale/gitlab/CurrentStatus.yml @@ -0,0 +1,13 @@ +--- +# Suggestion: gitlab.CurrentStatus +# +# Checks for words that indicate a product or feature may change in the future. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Avoid words like "%s" that promise future changes.' +level: suggestion +ignorecase: true +link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language-to-avoid +tokens: + - currently diff --git a/doc/.vale/gitlab/FirstPerson.yml b/doc/.vale/gitlab/FirstPerson.yml index 6db89dd4758..d247f137501 100644 --- a/doc/.vale/gitlab/FirstPerson.yml +++ b/doc/.vale/gitlab/FirstPerson.yml @@ -3,7 +3,7 @@ # # Checks for use of first person pronouns. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: '"%s" is a first-person pronoun. Use second- or third-person pronouns (like we, you, us, one) instead.' level: warning diff --git a/doc/.vale/gitlab/FutureTense.yml b/doc/.vale/gitlab/FutureTense.yml new file mode 100644 index 00000000000..a53a7dd29cc --- /dev/null +++ b/doc/.vale/gitlab/FutureTense.yml @@ -0,0 +1,17 @@ +--- +# Suggestion: gitlab.FutureTense +# +# Checks for use of future tense in sentences. Present tense is preferred as +# much as possible. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Avoid using future tense: "%s"' +ignorecase: true +level: warning +link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language-to-avoid +raw: + - "(going to( |\n|[[:punct:]])[a-zA-Z]*|" + - "will( |\n|[[:punct:]])[a-zA-Z]*|" + - "won't( |\n|[[:punct:]])[a-zA-Z]*|" + - "[a-zA-Z]*'ll( |\n|[[:punct:]])[a-zA-Z]*)" diff --git a/doc/.vale/gitlab/InternalLinkExtension.yml b/doc/.vale/gitlab/InternalLinkExtension.yml index 94a935196a7..61a08e4a86c 100644 --- a/doc/.vale/gitlab/InternalLinkExtension.yml +++ b/doc/.vale/gitlab/InternalLinkExtension.yml @@ -3,7 +3,7 @@ # # Checks that internal links have .md extenstion and not .html extension. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: 'Link "%s" must use the .md file extension.' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation diff --git a/doc/.vale/gitlab/LatinTerms.yml b/doc/.vale/gitlab/LatinTerms.yml index a2d024fb1ec..26dba42839a 100644 --- a/doc/.vale/gitlab/LatinTerms.yml +++ b/doc/.vale/gitlab/LatinTerms.yml @@ -3,7 +3,7 @@ # # Checks for use of latin terms. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: substitution message: 'Use "%s" instead of "%s", but consider rewriting the sentence.' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language diff --git a/doc/.vale/gitlab/MeaningfulLinkWords.yml b/doc/.vale/gitlab/MeaningfulLinkWords.yml index 1931112ab3e..4a255e5aae4 100644 --- a/doc/.vale/gitlab/MeaningfulLinkWords.yml +++ b/doc/.vale/gitlab/MeaningfulLinkWords.yml @@ -3,7 +3,7 @@ # # Checks for the presence of semantically unhelpful words in link text. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: 'Improve SEO and accessibility by rewriting "%s" in the link text.' level: warning diff --git a/doc/.vale/gitlab/MergeConflictMarkers.yml b/doc/.vale/gitlab/MergeConflictMarkers.yml index 4d733c856e5..4f216ac34c5 100644 --- a/doc/.vale/gitlab/MergeConflictMarkers.yml +++ b/doc/.vale/gitlab/MergeConflictMarkers.yml @@ -3,7 +3,7 @@ # # Checks for the presence of merge conflict markers. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: 'Merge conflict marker "%s" found.' link: https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-request diff --git a/doc/.vale/gitlab/OutdatedVersions.yml b/doc/.vale/gitlab/OutdatedVersions.yml new file mode 100644 index 00000000000..3252481a523 --- /dev/null +++ b/doc/.vale/gitlab/OutdatedVersions.yml @@ -0,0 +1,21 @@ +--- +# Warning: gitlab.OutdatedVersions +# +# Checks for references to versions of GitLab that are no longer supported. +# +# For a list of all options, see https://errata-ai.github.io/vale/styles/ +extends: existence +message: 'Can this reference to "%s" be refactored?' +link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#importance-of-referencing-gitlab-versions-and-tiers +level: warning +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." diff --git a/doc/.vale/gitlab/OxfordComma.yml b/doc/.vale/gitlab/OxfordComma.yml index e04d209d960..334db5d0388 100644 --- a/doc/.vale/gitlab/OxfordComma.yml +++ b/doc/.vale/gitlab/OxfordComma.yml @@ -4,7 +4,7 @@ # 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/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/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.html#punctuation diff --git a/doc/.vale/gitlab/ReferenceLinks.yml b/doc/.vale/gitlab/ReferenceLinks.yml index 8a3b6940187..49e6ed5a531 100644 --- a/doc/.vale/gitlab/ReferenceLinks.yml +++ b/doc/.vale/gitlab/ReferenceLinks.yml @@ -3,7 +3,7 @@ # # Checks for the presence of reference-style links that must be inline. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: 'Link "%s" must be inline.' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#basic-link-criteria diff --git a/doc/.vale/gitlab/RelativeLinks.yml b/doc/.vale/gitlab/RelativeLinks.yml index de24d0608e7..f7407375b84 100644 --- a/doc/.vale/gitlab/RelativeLinks.yml +++ b/doc/.vale/gitlab/RelativeLinks.yml @@ -3,7 +3,7 @@ # # Checks for the presence of absolute hyperlinks that should be relative. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: 'Link "%s" must be relative.' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation diff --git a/doc/.vale/gitlab/Repetition.yml b/doc/.vale/gitlab/Repetition.yml index 76afb7bb5ab..c4b0cc14192 100644 --- a/doc/.vale/gitlab/Repetition.yml +++ b/doc/.vale/gitlab/Repetition.yml @@ -3,7 +3,7 @@ # # Checks for duplicate words, like `the the` or `and and`. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: repetition message: '"%s" is repeated.' level: error diff --git a/doc/.vale/gitlab/SentenceLength.yml b/doc/.vale/gitlab/SentenceLength.yml index b19b76723a6..da9fa052584 100644 --- a/doc/.vale/gitlab/SentenceLength.yml +++ b/doc/.vale/gitlab/SentenceLength.yml @@ -3,7 +3,7 @@ # # 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/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: occurrence message: 'Shorter sentences improve readability (max 25 words).' scope: sentence diff --git a/doc/.vale/gitlab/SentenceSpacing.yml b/doc/.vale/gitlab/SentenceSpacing.yml index c460ef3ae65..e6da920222c 100644 --- a/doc/.vale/gitlab/SentenceSpacing.yml +++ b/doc/.vale/gitlab/SentenceSpacing.yml @@ -1,12 +1,12 @@ --- # Error: gitlab.SentenceSpacing # -# Check for the following in common content scenarios: +# Checks for the following in common content scenarios: # # - No spaces. # - More than one space. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: '"%s" must contain one and only one space.' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#punctuation diff --git a/doc/.vale/gitlab/Spelling.yml b/doc/.vale/gitlab/Spelling.yml index 7bf0f085f5c..602b7cd11e6 100644 --- a/doc/.vale/gitlab/Spelling.yml +++ b/doc/.vale/gitlab/Spelling.yml @@ -9,7 +9,7 @@ # Commands, like `git clone` must use backticks, and must not be added to the # exceptions. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: spelling message: 'Spelling check: "%s"?' level: warning diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml index 8c5f7705417..5324a48e38c 100644 --- a/doc/.vale/gitlab/SubstitutionWarning.yml +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -4,7 +4,7 @@ # 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/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: substitution message: 'If possible, use "%s" instead of "%s".' link: https://about.gitlab.com/handbook/communication/#top-misused-terms @@ -13,8 +13,11 @@ ignorecase: true swap: admin: administrator blacklist(ed|ing)?: denylist + code base: codebase config: configuration distro: distribution + file name: filename + filesystem: file system info: information repo: repository whitelist(ed|ing)?: allowlist diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index 156ff3a53f0..77536ea0b33 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -4,7 +4,7 @@ # 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.gitbook.io/vale/getting-started/styles extends: substitution message: 'Use "%s" instead of "%s".' link: https://about.gitlab.com/handbook/communication/#top-misused-terms diff --git a/doc/.vale/gitlab/VersionText.yml b/doc/.vale/gitlab/VersionText.yml index 9a05103cc39..3723170b169 100644 --- a/doc/.vale/gitlab/VersionText.yml +++ b/doc/.vale/gitlab/VersionText.yml @@ -13,7 +13,7 @@ # immediately on the next line is ok. However, this will often highlight where multi-line version # text is attempted without `-` characters. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: '"%s" is not formatted correctly.' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#text-for-documentation-requiring-version-text diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt index b56fa2861ca..28da80557ec 100644 --- a/doc/.vale/gitlab/spelling-exceptions.txt +++ b/doc/.vale/gitlab/spelling-exceptions.txt @@ -83,6 +83,7 @@ compilable composable Conda Consul +Contentful Corosync cron crons @@ -224,6 +225,7 @@ LDAP ldapsearch Leiningen Libravatar +liveness Lograge Logstash lookahead @@ -247,6 +249,7 @@ memoization memoize memoized memoizing +Memorystore mergeable Microsoft middleware @@ -334,8 +337,7 @@ Puma Python Qualys Rackspace -Raketask -Raketasks +Raspbian reachability rebase rebased @@ -423,6 +425,7 @@ storages strace strikethrough strikethroughs +stunnel subpath subfolder subfolders |