diff options
Diffstat (limited to 'doc/.vale')
32 files changed, 133 insertions, 87 deletions
diff --git a/doc/.vale/gitlab/Acronyms.yml b/doc/.vale/gitlab/Acronyms.yml index 494b1e42d2f..2c28da972da 100644 --- a/doc/.vale/gitlab/Acronyms.yml +++ b/doc/.vale/gitlab/Acronyms.yml @@ -14,6 +14,7 @@ first: '\b([A-Z]{3,5})\b' second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' # ... with the exception of these: exceptions: + - AJAX - ANSI - API - ARM @@ -21,28 +22,43 @@ exceptions: - ASCII - AWS - BSD + - CAS - CLI + - CNA - CNAME - CORE - CPU + - CRIME + - CSRF - CSS - CSV + - CVE - DAG - DAST - DHCP - DNS + - DOM + - DSA - DVCS + - ECDSA - EKS - EOL + - EXIF - FAQ - FOSS + - FQDN - GCP - GDK + - GDPR - GET + - GIF - GKE - GNU - GPG - GPL + - GUI + - HAML + - HIPAA - HTML - HTTP - HTTPS @@ -52,9 +68,13 @@ exceptions: - IDE - IID - IMAP + - IOPS - IRC - ISO + - JPEG + - JPG - JSON + - JWT - LAN - LDAP - LDAPS @@ -71,16 +91,25 @@ exceptions: - NOTE - NPM - ONLY + - OWASP + - PAT + - PCI-DSS - PDF + - PEM + - PEP - PGP - PHP + - PNG - POST - PUT - RAM + - RDP - REST + - RFC - RHEL - RPC - RPM + - RPS - RSA - RSS - RVM @@ -90,11 +119,17 @@ exceptions: - SCP - SCSS - SDK + - SEO - SHA - SLA + - SMS - SMTP + - SOC + - SOX + - SPF - SQL - SSD + - SSG - SSH - SSL - SSO @@ -111,9 +146,12 @@ exceptions: - URL - USB - UTC + - UTF - UUID + - VCS - VPC - WIP - WSL - XML + - XSS - YAML diff --git a/doc/.vale/gitlab/AlertBoxCaution.yml b/doc/.vale/gitlab/AlertBoxCaution.yml deleted file mode 100644 index 49d4dc62ab5..00000000000 --- a/doc/.vale/gitlab/AlertBoxCaution.yml +++ /dev/null @@ -1,14 +0,0 @@ ---- -# Error: gitlab.AlertBoxCaution -# -# Makes sure CAUTION: alert boxes follow standard formatting. -# -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles -extends: substitution -message: "CAUTION: alert boxes must be of the format 'CAUTION: **Caution:**'. 'Caution' can be replaced with 'Warning' or 'Important'." -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes -level: warning -nonword: true -scope: raw -swap: - 'CAUTION: *?\*\*.*\*\*': 'CAUTION: \*\*(?:Caution|Warning|Important):\*\*' diff --git a/doc/.vale/gitlab/AlertBoxDanger.yml b/doc/.vale/gitlab/AlertBoxDanger.yml deleted file mode 100644 index 2589d34614c..00000000000 --- a/doc/.vale/gitlab/AlertBoxDanger.yml +++ /dev/null @@ -1,14 +0,0 @@ ---- -# Error: gitlab.AlertBoxDanger -# -# Makes sure DANGER: alert boxes follow standard formatting. -# -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles -extends: substitution -message: "DANGER: alert boxes must be of the format 'DANGER: **Warning:**'. 'Warning' can be replaced with 'Important', 'Deprecated', or 'Required'." -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes -level: error -nonword: true -scope: raw -swap: - 'DANGER: *?\*\*.*\*\*': 'DANGER: \*\*(?:Warning|Important|Deprecated|Required):\*\*' diff --git a/doc/.vale/gitlab/AlertBoxNoteTip.yml b/doc/.vale/gitlab/AlertBoxNoteTip.yml deleted file mode 100644 index 0b480794476..00000000000 --- a/doc/.vale/gitlab/AlertBoxNoteTip.yml +++ /dev/null @@ -1,15 +0,0 @@ ---- -# Error: gitlab.AlertBoxNoteTip -# -# Makes sure NOTE: and TIP: alert boxes follow standard formatting. -# -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles -extends: substitution -message: "NOTE: and TIP: alert boxes must be of the format 'NOTE: **Note:**' or 'TIP: **Tip:**" -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes -level: warning -nonword: true -scope: raw -swap: - 'NOTE: *?\*\*.*\*\*': 'NOTE: \*\*Note:\*\*' - 'TIP: *?\*\*.*\*\*': 'TIP: \*\*Tip:\*\*' diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml index d15757d38fc..bdf66236ef2 100644 --- a/doc/.vale/gitlab/AlertBoxStyle.yml +++ b/doc/.vale/gitlab/AlertBoxStyle.yml @@ -1,18 +1,21 @@ --- # Error: gitlab.AlertBoxStyle # -# Makes sure alert boxes follow standard formatting. +# Makes sure alert boxes are used with block quotes. # -# Checks for 2 formatting issues: +# Checks for 3 formatting issues: +# - Alert boxes inside a block quote (">") # - Alert boxes with the note text on the same line -# - Alert boxes using blockquote formatting, like "> **Note:**" +# - Alert boxes using words other than "NOTE" or "WARNING" # # 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 in the style guide.' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes level: error +nonword: true scope: raw raw: - - '(\n(NOTE|TIP|CAUTION|DANGER): \*\*.*\*\*.+)|' - - '((\n[> ]*(\*){1,2}(NOTE|Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger):(\*){1,2}))' + - '(\n *\> *(?:NOTE|WARNING)|' + - '\n(NOTE):[^\n]|' # Adding "WARNING" here causes a false positive + - '\n *(?:> )?\**(Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger|warning):.*)' ## Adding "Warning" here causes a false positive diff --git a/doc/.vale/gitlab/BadgeCapitalization.yml b/doc/.vale/gitlab/BadgeCapitalization.yml index caf7143e254..3da5831ed56 100644 --- a/doc/.vale/gitlab/BadgeCapitalization.yml +++ b/doc/.vale/gitlab/BadgeCapitalization.yml @@ -6,7 +6,7 @@ # 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 +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#product-tier-badges level: error scope: raw raw: diff --git a/doc/.vale/gitlab/British.yml b/doc/.vale/gitlab/British.yml index 7221d7d24aa..65842ad7aa5 100644 --- a/doc/.vale/gitlab/British.yml +++ b/doc/.vale/gitlab/British.yml @@ -6,7 +6,7 @@ # 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 +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language level: error ignorecase: true swap: @@ -22,6 +22,10 @@ swap: behaviour: behavior busses: buses calibre: caliber + categorise: categorize + categorised: categorized + categorises: categorizes + categorising: categorizing centre: center cheque: check civilisation: civilization diff --git a/doc/.vale/gitlab/CodeblockFences.yml b/doc/.vale/gitlab/CodeblockFences.yml index 7258a8ef475..6c2d94e7b8d 100644 --- a/doc/.vale/gitlab/CodeblockFences.yml +++ b/doc/.vale/gitlab/CodeblockFences.yml @@ -6,7 +6,7 @@ # 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 +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#code-blocks level: error scope: raw raw: diff --git a/doc/.vale/gitlab/CurlStringsQuoted.yml b/doc/.vale/gitlab/CurlStringsQuoted.yml index a09c3fbfb51..e9fbabf5ffc 100644 --- a/doc/.vale/gitlab/CurlStringsQuoted.yml +++ b/doc/.vale/gitlab/CurlStringsQuoted.yml @@ -7,7 +7,7 @@ extends: existence message: 'For consistency across all cURL examples, always wrap the URL in double quotes ("): %s' link: https://docs.gitlab.com/ee/development/documentation/restful_api_styleguide.html#curl-commands -level: warning +level: error scope: code raw: - 'curl.*[^"=]https?://.*' diff --git a/doc/.vale/gitlab/CurrentStatus.yml b/doc/.vale/gitlab/CurrentStatus.yml index 584ac73aa17..16a6995843a 100644 --- a/doc/.vale/gitlab/CurrentStatus.yml +++ b/doc/.vale/gitlab/CurrentStatus.yml @@ -8,6 +8,6 @@ extends: existence message: 'Avoid words like "%s" that promise future changes, because documentation is about the current state of the product.' level: suggestion ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language-to-avoid +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list tokens: - currently diff --git a/doc/.vale/gitlab/FirstPerson.yml b/doc/.vale/gitlab/FirstPerson.yml index d247f137501..6fc93d9515c 100644 --- a/doc/.vale/gitlab/FirstPerson.yml +++ b/doc/.vale/gitlab/FirstPerson.yml @@ -8,7 +8,7 @@ extends: existence 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 +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list tokens: - '\bI[ ,;:?!"]|\bI\x27.{1,2}' - me diff --git a/doc/.vale/gitlab/FutureTense.yml b/doc/.vale/gitlab/FutureTense.yml index bba60dc9657..d7001d57899 100644 --- a/doc/.vale/gitlab/FutureTense.yml +++ b/doc/.vale/gitlab/FutureTense.yml @@ -9,7 +9,7 @@ extends: existence message: 'Avoid using future tense: "%s". Use present tense instead.' ignorecase: true level: warning -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language-to-avoid +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list raw: - "(going to( |\n|[[:punct:]])[a-zA-Z]*|" - "will( |\n|[[:punct:]])[a-zA-Z]*|" diff --git a/doc/.vale/gitlab/InclusionAbleism.yml b/doc/.vale/gitlab/InclusionAbleism.yml index 29b26547130..1ebb6a97cf8 100644 --- a/doc/.vale/gitlab/InclusionAbleism.yml +++ b/doc/.vale/gitlab/InclusionAbleism.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: substitution message: 'Use inclusive language. Consider "%s" instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#inclusive-language +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language level: suggestion ignorecase: true swap: diff --git a/doc/.vale/gitlab/InclusionCultural.yml b/doc/.vale/gitlab/InclusionCultural.yml index 5bfad84f100..6f63d1725fc 100644 --- a/doc/.vale/gitlab/InclusionCultural.yml +++ b/doc/.vale/gitlab/InclusionCultural.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: substitution message: 'Use inclusive language. Consider "%s" instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#inclusive-language +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language level: warning ignorecase: true swap: diff --git a/doc/.vale/gitlab/InclusionGender.yml b/doc/.vale/gitlab/InclusionGender.yml index 389d76d7a24..313a1cc42dc 100644 --- a/doc/.vale/gitlab/InclusionGender.yml +++ b/doc/.vale/gitlab/InclusionGender.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: substitution message: 'Use inclusive language. Consider "%s" instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#inclusive-language +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language level: suggestion ignorecase: true swap: diff --git a/doc/.vale/gitlab/InternalLinkCase.yml b/doc/.vale/gitlab/InternalLinkCase.yml new file mode 100644 index 00000000000..c00e633426b --- /dev/null +++ b/doc/.vale/gitlab/InternalLinkCase.yml @@ -0,0 +1,13 @@ +--- +# Error: gitlab.InternalLinkCase +# +# Checks that anchor fragments on internal links are in lower-case. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Links to subheadings in GitLab docs must be in lower-case: "%s"' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation +level: error +scope: raw +raw: + - '[^\`]\[[^\[\]]+\]\((https?:){0}[\w\/\.]*?#[^\s]*?[A-Z][^\) ]*\)[^\`]' diff --git a/doc/.vale/gitlab/InternalLinkExtension.yml b/doc/.vale/gitlab/InternalLinkExtension.yml index 9b5a3499815..0b1baaf667c 100644 --- a/doc/.vale/gitlab/InternalLinkExtension.yml +++ b/doc/.vale/gitlab/InternalLinkExtension.yml @@ -6,7 +6,7 @@ # 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 +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation level: error scope: raw raw: diff --git a/doc/.vale/gitlab/InternalLinkFormat.yml b/doc/.vale/gitlab/InternalLinkFormat.yml index 9a72778140e..51d5198a0ce 100644 --- a/doc/.vale/gitlab/InternalLinkFormat.yml +++ b/doc/.vale/gitlab/InternalLinkFormat.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: 'Link "%s" must not start with "./".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation level: error scope: raw raw: diff --git a/doc/.vale/gitlab/LatinTerms.yml b/doc/.vale/gitlab/LatinTerms.yml index 26dba42839a..79ba4c17651 100644 --- a/doc/.vale/gitlab/LatinTerms.yml +++ b/doc/.vale/gitlab/LatinTerms.yml @@ -1,12 +1,12 @@ --- # Warning: gitlab.LatinTerms # -# Checks for use of latin terms. +# Checks for use of Latin terms. # # 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 +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list level: warning nonword: true ignorecase: true diff --git a/doc/.vale/gitlab/OutdatedVersions.yml b/doc/.vale/gitlab/OutdatedVersions.yml index 2ce61ee5798..05323726838 100644 --- a/doc/.vale/gitlab/OutdatedVersions.yml +++ b/doc/.vale/gitlab/OutdatedVersions.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/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 +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#gitlab-versions level: suggestion nonword: true ignorecase: true diff --git a/doc/.vale/gitlab/OxfordComma.yml b/doc/.vale/gitlab/OxfordComma.yml index 334db5d0388..0425d9e1dd0 100644 --- a/doc/.vale/gitlab/OxfordComma.yml +++ b/doc/.vale/gitlab/OxfordComma.yml @@ -7,7 +7,7 @@ # 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 +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation level: warning raw: - '(?:[\w-_` ]+,){2,}(?:[\w-_` ]+) (and |or )' diff --git a/doc/.vale/gitlab/Possessive.yml b/doc/.vale/gitlab/Possessive.yml new file mode 100644 index 00000000000..eadf7359698 --- /dev/null +++ b/doc/.vale/gitlab/Possessive.yml @@ -0,0 +1,15 @@ +--- +# Warning: gitlab.Possessive +# +# The word GitLab should not be used in the possessive form. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Rewrite "%s" to not use "’s".' +level: error +ignorecase: true +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#trademark +tokens: + - GitLab's # Straight apostrophe. + - GitLab’s # Curly closing apostrophe. + - GitLab‘s # Curly opening apostrophe. diff --git a/doc/.vale/gitlab/ReferenceLinks.yml b/doc/.vale/gitlab/ReferenceLinks.yml index 49e6ed5a531..0df1f359107 100644 --- a/doc/.vale/gitlab/ReferenceLinks.yml +++ b/doc/.vale/gitlab/ReferenceLinks.yml @@ -6,7 +6,7 @@ # 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 +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#basic-link-criteria level: error scope: raw raw: diff --git a/doc/.vale/gitlab/RelativeLinks.yml b/doc/.vale/gitlab/RelativeLinks.yml index 1ae73472f8a..14ffc4bd0b8 100644 --- a/doc/.vale/gitlab/RelativeLinks.yml +++ b/doc/.vale/gitlab/RelativeLinks.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: 'Link "%s" must be a relative link with a .md extension.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation level: error scope: raw raw: diff --git a/doc/.vale/gitlab/SentenceLength.yml b/doc/.vale/gitlab/SentenceLength.yml index da9fa052584..c60df1803e2 100644 --- a/doc/.vale/gitlab/SentenceLength.yml +++ b/doc/.vale/gitlab/SentenceLength.yml @@ -7,7 +7,7 @@ extends: occurrence message: 'Shorter sentences improve readability (max 25 words).' scope: sentence -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language level: warning max: 25 token: \b(\w+)\b diff --git a/doc/.vale/gitlab/SentenceSpacing.yml b/doc/.vale/gitlab/SentenceSpacing.yml index e6da920222c..884d4b57508 100644 --- a/doc/.vale/gitlab/SentenceSpacing.yml +++ b/doc/.vale/gitlab/SentenceSpacing.yml @@ -9,7 +9,7 @@ # 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 +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation level: error nonword: true tokens: diff --git a/doc/.vale/gitlab/Simplicity.yml b/doc/.vale/gitlab/Simplicity.yml index fa7a07c3e81..44e78f89c20 100644 --- a/doc/.vale/gitlab/Simplicity.yml +++ b/doc/.vale/gitlab/Simplicity.yml @@ -8,7 +8,7 @@ extends: existence message: 'Avoid words like "%s" that imply ease of use, because the user may find this action hard.' level: suggestion ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language-to-avoid +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list tokens: - easy - easily diff --git a/doc/.vale/gitlab/SubstitutionSuggestions.yml b/doc/.vale/gitlab/SubstitutionSuggestions.yml index df68961b1ce..82e3e789864 100644 --- a/doc/.vale/gitlab/SubstitutionSuggestions.yml +++ b/doc/.vale/gitlab/SubstitutionSuggestions.yml @@ -6,12 +6,16 @@ # # For a list of all options, see https://errata-ai.github.io/vale/styles/ extends: substitution -message: 'Consider "%s" instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language +message: 'Consider %s instead of "%s".' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language level: suggestion ignorecase: true swap: - since: because - once that: after that - once the: after the - once you: after you + active user: '"billable user"' + active users: '"billable users"' + docs: documentation + once that: '"after that"' + once the: '"after the"' + once you: '"after you"' + since: '"because" or "after"' + within: '"in"' diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index 3d1cf8057eb..0a56524e3f5 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -11,8 +11,10 @@ link: https://about.gitlab.com/handbook/communication/#top-misused-terms level: error ignorecase: true swap: + Customer [Pp]ortal: Customers Portal frontmatter: front matter GitLabber: GitLab team member + GitLabbers: GitLab team members GitLab-shell: GitLab Shell gitlab omnibus: Omnibus GitLab param: parameter diff --git a/doc/.vale/gitlab/ToDo.yml b/doc/.vale/gitlab/ToDo.yml index b3c5f6077b1..a3725cb7f6b 100644 --- a/doc/.vale/gitlab/ToDo.yml +++ b/doc/.vale/gitlab/ToDo.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: substitution message: 'Use "to-do item" in most cases, or "Add a to do" if referring to the UI button.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#feature-names +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#feature-names level: warning ignorecase: false swap: diff --git a/doc/.vale/gitlab/VersionText.yml b/doc/.vale/gitlab/VersionText.yml index e59b936ae3f..e66a62497b1 100644 --- a/doc/.vale/gitlab/VersionText.yml +++ b/doc/.vale/gitlab/VersionText.yml @@ -16,7 +16,7 @@ # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence message: 'This introduced-in line is not formatted correctly.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#text-for-documentation-requiring-version-text +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#version-text-in-the-version-history level: error scope: raw raw: diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt index bbb5c892298..fd3aff63bce 100644 --- a/doc/.vale/gitlab/spelling-exceptions.txt +++ b/doc/.vale/gitlab/spelling-exceptions.txt @@ -8,7 +8,6 @@ allowlists anonymized Ansible Anthos -API approvers architected Artifactory @@ -63,7 +62,6 @@ bundlers burndown burnup cacheable -CAS CentOS Certbot chai @@ -120,6 +118,7 @@ dequarantining DevOps discoverability Disqus +Divio Dockerfile Dockerfiles dogfood @@ -171,6 +170,8 @@ globals Gmail Gollum Google +goroutine +goroutines Gosec Gradle Grafana @@ -211,12 +212,13 @@ JavaScript Jenkins Jenkinsfile Jira +jq jQuery jsdom JupyterHub kanban kanbans -Kaniko +kaniko Karma Kerberos keyset @@ -224,15 +226,15 @@ Kibana Kinesis Knative Kramdown +Kroki Kubecost kubectl Kubernetes Kubesec Laravel -LDAP ldapsearch -Leiningen Lefthook +Leiningen Libravatar liveness Lograge @@ -252,6 +254,7 @@ Markdown markdownlint matcher matchers +Matomo Mattermost mbox memoization @@ -293,10 +296,10 @@ namespacing namespacings Nanoc Netlify -NGINX Nokogiri npm Nurtch +nyc OAuth offboarded offboarding @@ -317,6 +320,7 @@ PgBouncer Phabricator phaser phasers +phpenv Pipfile Pipfiles Piwik @@ -341,9 +345,13 @@ prepend prepended prepending prepends +Prettifier Pritaly +Priyanka profiler Prometheus +protobuf +protobufs proxied proxies proxyable @@ -396,7 +404,6 @@ reusability reverified reverifies reverify -RHEL rollout rollouts rsync @@ -413,7 +420,6 @@ runit runtime runtimes Salesforce -SAML sandboxing sanitization sbt @@ -436,7 +442,6 @@ Slack Slony smartcard smartcards -SMTP Sobelow Solarized Sourcegraph @@ -445,7 +450,6 @@ sparklines spidering Splunk SpotBugs -SSH Stackdriver storable storages @@ -476,7 +480,10 @@ substrings subtree subtrees sudo +swimlane +swimlanes syslog +tanuki tcpdump Thanos Tiller @@ -489,6 +496,9 @@ toolchain toolchains tooltip tooltips +transpile +transpiles +transpiling Trello triaging Twilio |