diff --git a/.hyperlint/automations/styles/cloudflare-automation/EOLWhitespace.yml b/.hyperlint/automations/styles/cloudflare-automation/EOLWhitespace.yml index 1ed600349a57521..2c2fccebb178378 100644 --- a/.hyperlint/automations/styles/cloudflare-automation/EOLWhitespace.yml +++ b/.hyperlint/automations/styles/cloudflare-automation/EOLWhitespace.yml @@ -3,7 +3,7 @@ name: gitlab_base.EOLWhitespace description: | Checks that there is no useless whitespace at the end of lines. extends: existence -message: "Remove whitespace characters from the end of the line." +message: "Remove whitespace characters from the end of the line. Only remove the whitespace and nothing else." link: https://docs.gitlab.com/development/documentation/styleguide/ vocab: false level: warning diff --git a/.hyperlint/automations/styles/cloudflare-automation/HeadingLinks.yml b/.hyperlint/automations/styles/cloudflare-automation/HeadingLinks.yml index 617701811ea4c42..822a8429a801b46 100644 --- a/.hyperlint/automations/styles/cloudflare-automation/HeadingLinks.yml +++ b/.hyperlint/automations/styles/cloudflare-automation/HeadingLinks.yml @@ -2,11 +2,9 @@ name: gitlab_base.HeadingLink description: | Do not include links in a heading. - Headings already have self-referencing anchor links, - and they're used for generating the table of contents. - Adding a link will break the anchor linking behavior. + Headings already have self-referencing anchor links. extends: existence -message: "Do not use links in headings." +message: "Do not use links in headings. Only update the links and nothing else." vocab: false level: error ignorecase: true diff --git a/.hyperlint/automations/styles/cloudflare-automation/HeadingPunctuation.yml b/.hyperlint/automations/styles/cloudflare-automation/HeadingPunctuation.yml index 4954cb11aeb926d..6bac39fec7ea366 100644 --- a/.hyperlint/automations/styles/cloudflare-automation/HeadingPunctuation.yml +++ b/.hyperlint/automations/styles/cloudflare-automation/HeadingPunctuation.yml @@ -1,5 +1,5 @@ extends: existence -message: "Don't use end punctuation in headings." +message: "Don't use end punctuation in headings. Only update the punctuation and nothing else." link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods nonword: true level: warning diff --git a/.hyperlint/automations/styles/cloudflare-automation/NonStandardQuotes.yml b/.hyperlint/automations/styles/cloudflare-automation/NonStandardQuotes.yml index 36a76b8006cf0ce..1ad30105512cbb4 100644 --- a/.hyperlint/automations/styles/cloudflare-automation/NonStandardQuotes.yml +++ b/.hyperlint/automations/styles/cloudflare-automation/NonStandardQuotes.yml @@ -5,7 +5,7 @@ # # 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." +message: "Use standard single quotes or double quotes only. Do not use left or right quotes. Only update the quotes and nothing else." level: warning ignorecase: true link: https://developers.cloudflare.com/style-guide/grammar/punctuation-marks-and-symbols/quotation-marks/ diff --git a/.hyperlint/automations/styles/cloudflare-automation/UnclearAntecedent.yml b/.hyperlint/automations/styles/cloudflare-automation/UnclearAntecedent.yml index 2c8f9e5af70dfb9..bc15c343945834a 100644 --- a/.hyperlint/automations/styles/cloudflare-automation/UnclearAntecedent.yml +++ b/.hyperlint/automations/styles/cloudflare-automation/UnclearAntecedent.yml @@ -3,7 +3,7 @@ name: gitlab_base.UnclearAntecedent description: | Checks for words that need a noun for clarity. extends: existence -message: "Instead of '%s', try starting this sentence with a specific subject and verb." +message: "Instead of '%s', try starting this sentence with a specific subject and verb. Only update this part of the sentence and nothing else." link: https://docs.gitlab.com/development/documentation/styleguide/word_list/#this-these-that-those vocab: false level: warning diff --git a/.hyperlint/automations/styles/cloudflare/Contractions.yml b/.hyperlint/automations/styles/cloudflare/Contractions.yml index b35e1263496d0df..c4804154e1f371b 100644 --- a/.hyperlint/automations/styles/cloudflare/Contractions.yml +++ b/.hyperlint/automations/styles/cloudflare/Contractions.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: "Do not use contractions. Use '%s' instead of '%s'." +message: "Do not use contractions. Use '%s' instead of '%s'. Only change the contractions, nothing else." link: https://developers.cloudflare.com/style-guide/grammar/parts-of-speech/contractions/ level: error ignorecase: true diff --git a/.hyperlint/automations/styles/cloudflare/InclusiveLanguage.yml b/.hyperlint/automations/styles/cloudflare/InclusiveLanguage.yml index 9bfbb4cc673b8aa..37f0e270ef5c196 100644 --- a/.hyperlint/automations/styles/cloudflare/InclusiveLanguage.yml +++ b/.hyperlint/automations/styles/cloudflare/InclusiveLanguage.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: "**Warning**: Use inclusive language. Consider '%s' instead of '%s'." +message: "**Warning**: Use inclusive language. Consider '%s' instead of '%s'. Only change the words specified, nothing else." level: warning ignorecase: true swap: diff --git a/.hyperlint/automations/styles/cloudflare/LatinTerms.yml b/.hyperlint/automations/styles/cloudflare/LatinTerms.yml index d47be895c5a8383..1929a654e28c2a4 100644 --- a/.hyperlint/automations/styles/cloudflare/LatinTerms.yml +++ b/.hyperlint/automations/styles/cloudflare/LatinTerms.yml @@ -7,7 +7,7 @@ # 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." +message: "Use '%s' instead of '%s'. Only change the words specified, nothing else." link: https://developers.cloudflare.com/style-guide/grammar/parts-of-speech/abbreviations/#ie-vs-eg level: warning nonword: true diff --git a/.hyperlint/automations/styles/cloudflare/LinkChecks.yml b/.hyperlint/automations/styles/cloudflare/LinkChecks.yml index 07fa68ecae7b5ff..9cda302a709b2d4 100644 --- a/.hyperlint/automations/styles/cloudflare/LinkChecks.yml +++ b/.hyperlint/automations/styles/cloudflare/LinkChecks.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: "**Warning**: When referring to another page in our docs, use the full relative link (`/1.1.1.1/check/`) instead of the full URL (`https://developers.cloudflare.com/1.1.1.1/check/`) or a local development link (`http://localhost:1111/1.1.1.1/check/`)." +message: "When referring to another page in our docs, use the full relative link (`/1.1.1.1/check/`) instead of the full URL (`https://developers.cloudflare.com/1.1.1.1/check/`) or a local development link (`http://localhost:1111/1.1.1.1/check/`). Only change the link, nothing else." level: warning ignorecase: true scope: raw diff --git a/.hyperlint/automations/styles/cloudflare/MeaningfulLinkWords.yml b/.hyperlint/automations/styles/cloudflare/MeaningfulLinkWords.yml index 21f9f566600d262..bd4f376fbe0d0de 100644 --- a/.hyperlint/automations/styles/cloudflare/MeaningfulLinkWords.yml +++ b/.hyperlint/automations/styles/cloudflare/MeaningfulLinkWords.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: "**Warning**: Rewrite the link text for `%s` to be more descriptive. For more information, refer to [Descriptive link text](https://developers.cloudflare.com/style-guide/formatting/structure/links/#descriptive-link-text)." +message: "Rewrite the link text for `%s` to be more descriptive. Only rewrite the link text, nothing else." level: warning ignorecase: true scope: raw diff --git a/.hyperlint/automations/styles/cloudflare/Repetition.yml b/.hyperlint/automations/styles/cloudflare/Repetition.yml index 373b8595f62020c..b3bc926b7f3cd1a 100644 --- a/.hyperlint/automations/styles/cloudflare/Repetition.yml +++ b/.hyperlint/automations/styles/cloudflare/Repetition.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: repetition -message: "**Warning**: Remove this duplicate word: '%s'." +message: "**Warning**: Remove this duplicate word: '%s'. Only remove this duplicate word and nothing else." level: warning alpha: true tokens: diff --git a/.hyperlint/automations/styles/plain-text-style-checks/spelling.md b/.hyperlint/automations/styles/plain-text-style-checks/spelling.md index 5fb8bcc6ba0e7c7..c91ab1390d349e6 100644 --- a/.hyperlint/automations/styles/plain-text-style-checks/spelling.md +++ b/.hyperlint/automations/styles/plain-text-style-checks/spelling.md @@ -1 +1 @@ -Fix spelling errors. +Fix spelling errors in the text. Only fix these spelling errors and nothing else.