diff options
Diffstat (limited to 'doc/.vale/gitlab')
| -rw-r--r-- | doc/.vale/gitlab/GitLabFlavoredMarkdown.yml | 14 | ||||
| -rw-r--r-- | doc/.vale/gitlab/HeadingDepth.yml | 4 | ||||
| -rw-r--r-- | doc/.vale/gitlab/SentenceLength.yml | 4 | ||||
| -rw-r--r-- | doc/.vale/gitlab/Spelling.yml | 2 | ||||
| -rw-r--r-- | doc/.vale/gitlab/SubstitutionWarning.yml | 6 | ||||
| -rw-r--r-- | doc/.vale/gitlab/TabsLinks.yml | 13 | ||||
| -rw-r--r-- | doc/.vale/gitlab/Uppercase.yml | 9 | ||||
| -rw-r--r-- | doc/.vale/gitlab/spelling-exceptions.txt | 10 |
8 files changed, 47 insertions, 15 deletions
diff --git a/doc/.vale/gitlab/GitLabFlavoredMarkdown.yml b/doc/.vale/gitlab/GitLabFlavoredMarkdown.yml new file mode 100644 index 00000000000..532f1afd816 --- /dev/null +++ b/doc/.vale/gitlab/GitLabFlavoredMarkdown.yml @@ -0,0 +1,14 @@ +--- +# 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" diff --git a/doc/.vale/gitlab/HeadingDepth.yml b/doc/.vale/gitlab/HeadingDepth.yml index 7a3e5b4b552..5bbe667481c 100644 --- a/doc/.vale/gitlab/HeadingDepth.yml +++ b/doc/.vale/gitlab/HeadingDepth.yml @@ -1,5 +1,5 @@ --- -# Warning: gitlab.HeadingDepth +# Suggestion: gitlab.HeadingDepth # # Checks that there are no headings greater than 3 levels # @@ -7,7 +7,7 @@ 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#headings-in-markdown -level: warning +level: suggestion scope: raw raw: - '(?<=\n)#{5,}\s.*' diff --git a/doc/.vale/gitlab/SentenceLength.yml b/doc/.vale/gitlab/SentenceLength.yml index 69b0d27072e..48ebf02bc7f 100644 --- a/doc/.vale/gitlab/SentenceLength.yml +++ b/doc/.vale/gitlab/SentenceLength.yml @@ -1,5 +1,5 @@ --- -# Warning: gitlab.SentenceLength +# Suggestion: gitlab.SentenceLength # # Counts words in a sentence and alerts if a sentence exceeds 25 words. # @@ -8,6 +8,6 @@ extends: occurrence message: "Improve readability by using fewer than 25 words in this sentence." scope: sentence link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language -level: warning +level: suggestion max: 25 token: \b(\w+)\b diff --git a/doc/.vale/gitlab/Spelling.yml b/doc/.vale/gitlab/Spelling.yml index 92c5cb13b29..74d919831ac 100644 --- a/doc/.vale/gitlab/Spelling.yml +++ b/doc/.vale/gitlab/Spelling.yml @@ -10,7 +10,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: spelling -message: "Check the spelling of '%s'. If the spelling is correct, add this word to the spelling exception list." +message: "Check the spelling of '%s'. If the spelling is correct, ask a Technical Writer to add this word to the spelling exception list." level: warning ignore: - gitlab/spelling-exceptions.txt diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml index 383ae38da16..8f3d3330271 100644 --- a/doc/.vale/gitlab/SubstitutionWarning.yml +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -26,10 +26,10 @@ swap: ex: "for example" file name: "filename" filesystem: "file system" - GLFM: "GitLab Flavored Markdown" - GFM: "GitLab Flavored Markdown' or 'GitHub Flavored Markdown" info: "information" it is recommended: "you should" + logged in user: "authenticated user" + logged-in user: "authenticated user" n/a: "not applicable" navigate to: "go to" OAuth2: "OAuth 2.0" @@ -37,6 +37,8 @@ swap: once the: "after the" once you: "after you" repo: "repository" + signed in user: "authenticated user" + signed-in user: "authenticated user" since: "because' or 'after" sub-group: "subgroup" sub-groups: "subgroups" diff --git a/doc/.vale/gitlab/TabsLinks.yml b/doc/.vale/gitlab/TabsLinks.yml new file mode 100644 index 00000000000..97f75046fca --- /dev/null +++ b/doc/.vale/gitlab/TabsLinks.yml @@ -0,0 +1,13 @@ +--- +# Error: gitlab.TabsLinks +# +# Checks for the presence of links to individual GitLab UI tabs. +# +# For a list of all options, see https://vale.sh/docs/topics/styles/ +extends: existence +message: "Do not include tabs query parameters in links." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#tabs +level: error +scope: raw +raw: + - '\[[^\]]+\]\(.*?\.md\?tab=.*?\)' diff --git a/doc/.vale/gitlab/Uppercase.yml b/doc/.vale/gitlab/Uppercase.yml index 039ad7c5f03..19e0fec6622 100644 --- a/doc/.vale/gitlab/Uppercase.yml +++ b/doc/.vale/gitlab/Uppercase.yml @@ -1,13 +1,13 @@ --- -# Warning: gitlab.Uppercase +# Suggestion: gitlab.Uppercase # # Checks for use of all uppercase letters with unknown reason. # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: conditional -message: "Instead of uppercase for '%s', use lowercase or backticks (`) if possible. Otherwise, add this word or acronym to the rule's exception list." +message: "Instead of uppercase for '%s', use lowercase or backticks (`) if possible. Otherwise, ask a Technical Writer to add this word or acronym to the rule's exception list." link: https://docs.gitlab.com/ee/development/documentation/testing.html#vale-uppercase-acronym-test -level: warning +level: suggestion ignorecase: false # Ensures that the existence of 'first' implies the existence of 'second'. first: '\b([A-Z]{3,5})\b' @@ -47,10 +47,10 @@ exceptions: - CSS - CSV - CTE - - CWE - CVE - CVS - CVSS + - CWE - DAG - DAST - DDL @@ -148,6 +148,7 @@ exceptions: - NTP - OCI - OKD + - OKR - ONLY - OSS - OTP diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt index 81b21f026f4..5403b80141e 100644 --- a/doc/.vale/gitlab/spelling-exceptions.txt +++ b/doc/.vale/gitlab/spelling-exceptions.txt @@ -377,6 +377,7 @@ Getter Getters gettext GIDs +gists Git Gitaly Gitea @@ -547,8 +548,8 @@ Mattermost mbox memoization memoize -memoizes memoized +memoizes memoizing Memorystore mergeability @@ -589,8 +590,8 @@ mutex nameserver nameservers namespace -namespaced namespace's +namespaced namespaces namespacing namespacings @@ -620,6 +621,7 @@ offboarding offboards OIDs OKRs +OKRs Okta OmniAuth onboarding @@ -639,12 +641,12 @@ Packwerk paginator parallelization parallelizations +parsable PascalCase PascalCased passthrough passthroughs passwordless -parsable Patroni PDFs performant @@ -827,8 +829,8 @@ Salesforce sandboxing sanitization SBOMs -SBT sbt +SBT scalers scatterplot scatterplots |