init

doc/.vale/gitlab/Possessive.yml

+---
+# Error: gitlab.Possessive
+#
+# The word GitLab should not be used in the possessive form.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Remove 's from %s."
+level: error
+ignorecase: true
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#gitlab
+tokens:
+  - GitLab's

doc/.vale/gitlab/Prerequisites.yml

+---
+# Error: gitlab.Prerequisites
+#
+# The "Prerequisites:" line should always be plural.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Pluralize 'Prerequisites', even if it includes only one item."
+link: https://docs.gitlab.com/ee/development/documentation/topic_types/task.html#task-prerequisites
+level: warning
+nonword: true
+scope: text
+raw:
+  - '^Prerequisite:'

doc/.vale/gitlab/ReadingLevel.yml

+---
+# Suggestion: gitlab.ReadingLevel
+#
+# Checks the Flesch-Kincaid reading level.
+#
+# https://docs.errata.ai/vale/styles#metric
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: metric
+message: "The grade level is %s. Aim for 8th grade or lower by using shorter sentences and words."
+link: https://docs.gitlab.com/ee/development/documentation/testing/vale.html#readability-score
+level: suggestion
+formula: |
+  (0.39 * (words / sentences)) + (11.8 * (syllables / words)) - 15.59
+condition: "> 1"

doc/.vale/gitlab/ReferenceLinks.yml

+---
+# Error: gitlab.ReferenceLinks
+#
+# Checks for reference-style links that should be converted to inline links.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Put this link inline with the rest of the text."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links
+level: error
+scope: raw
+raw:
+  - '\n\[[^\]]*\]: .*'

doc/.vale/gitlab/RelativeLinks.yml

+---
+# Error: gitlab.RelativeLinks
+#
+# Checks for the presence of absolute hyperlinks that should be relative.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Use a relative link instead of a URL, and ensure the file name ends in .md and not .html."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links
+level: error
+scope: raw
+raw:
+  - '\[[^\]]+\]\(https?:\/\/docs\.gitlab\.com\/omnibus.*\)'

doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml

+---
+# Error: gitlab.RelativeLinksDoubleSlashes
+#
+# Checks for the presence of double slashes in relative URLs.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Do not use double slashes '//' or '../doc' in the link path"
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links
+level: error
+scope: raw
+raw:
+  - '(\.//)|(\.\.\/doc\/)'

doc/.vale/gitlab/Repetition.yml

+---
+# Error: gitlab.Repetition
+#
+# Checks for duplicate words, like `the the` or `and and`.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: repetition
+message: "Remove this duplicate word: '%s'."
+level: error
+alpha: true
+tokens:
+  - '[^\s]+'

doc/.vale/gitlab/SentenceLength.yml

+---
+# Suggestion: gitlab.SentenceLength
+#
+# Counts words in a sentence and alerts if a sentence exceeds 25 words.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+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: suggestion
+max: 25
+token: \b(\w+)\b

doc/.vale/gitlab/SentenceSpacing.yml

+---
+# Error: gitlab.SentenceSpacing
+#
+# Checks for incorrect spacing (no spaces, or more than one space) around punctuation.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Use exactly one space between sentences and clauses. Check '%s' for spacing problems."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation
+level: error
+nonword: true
+tokens:
+  - '[a-z][.?!,][A-Z]'
+  - '[\w.?!,\(\)\-":] {2,}[\w.?!,\(\)\-":]'

doc/.vale/gitlab/Simplicity.yml

+---
+# Warning: gitlab.Simplicity
+#
+# Checks for words implying ease of use, to avoid cognitive dissonance for frustrated users.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Remove '%s'. Be precise instead of subjective."
+level: warning
+ignorecase: true
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
+tokens:
+  - easy
+  - easily
+  - handy
+  - simple
+  - simply
+  - useful

doc/.vale/gitlab/Spelling.yml

+---
+# Warning: gitlab.Spelling
+#
+# Checks for possible spelling mistakes in content, not code. Results from links using angle brackets (<https://example.com>) should be corrected.
+#
+# If a word is flagged as a spelling mistake incorrectly, such as a product name,
+# you can submit an MR to update `spelling-exceptions.txt` with the missing word.
+# Commands, like `git clone` must use backticks, and must not be added to the
+# exceptions.
+#
+# 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, ask a Technical Writer to add this word to the spelling exception list."
+level: warning
+ignore:
+  - gitlab/spelling-exceptions.txt

doc/.vale/gitlab/SubstitutionWarning.yml

+---
+# Warning: gitlab.SubstitutionWarning
+#
+# Checks for misused terms or common shorthand that should not be used at GitLab, but can't be flagged as errors.
+# Substitutions.yml also exists.
+#
+# 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:
+  active user: "billable user"
+  active users: "billable users"
+  air(?:-| )?gapped: "offline environment"
+  bullet: "list item"
+  (?<!right-)click(?!-through): "select"
+  code base: "codebase"
+  config: "configuration"
+  confirmation box: "confirmation dialog"
+  confirmation dialog box: "confirmation dialog"
+  deselect: "clear"
+  deselected: "cleared"
+  dialog box: "dialog"
+  distro: "distribution"
+  docs: "documentation"
+  e-mail: "email"
+  emojis: "emoji"
+  ex: "for example"
+  file name: "filename"
+  filesystem: "file system"
+  fullscreen: "full screen"
+  info: "information"
+  installation from source: self-compiled installation
+  installations from source: self-compiled installations
+  it is recommended: "you should"
+  logged in user: "authenticated user"
+  logged-in user: "authenticated user"
+  machine-learning: "machine learning"
+  modal dialog: "dialog"
+  modal window: "dialog"
+  modal: "dialog"
+  n/a: "not applicable"
+  navigate to: "go to"
+  OAuth2: "OAuth 2.0"
+  omnibus gitlab: "Linux package"
+  'omnibus(?!\))': "Linux package"
+  once that: "after that"
+  once the: "after the"
+  once you: "after you"
+  pack file: packfile
+  pack files: packfiles
+  pop-up window: "dialog"
+  pop-up: "dialog"
+  popup: "dialog"
+  repo: "repository"
+  signed in user: "authenticated user"
+  signed-in user: "authenticated user"
+  since: "because' or 'after"
+  source (?:install|installation): self-compiled installation
+  source (?:installs|installations): self-compiled installations
+  sub-group: "subgroup"
+  sub-groups: "subgroups"
+  timezone: "time zone"
+  utiliz(?:es?|ing): "use"
+  VSCode: "VS Code"
+  we recommend: "you should"
+  within: "in"

doc/.vale/gitlab/Substitutions.yml

+---
+# Error: gitlab.Substitutions
+#
+# Checks for misused terms that should never be used at GitLab.
+# SubstitutionWarning.yml also exists.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: substitution
+message: "Use '%s' instead of '%s'."
+link: https://handbook.gitlab.com/handbook/communication/top-misused-terms/
+level: error
+ignorecase: true
+swap:
+  admin user: administrator
+  admin users: administrators
+  administrator permission: administrator access
+  administrator permissions: administrator access
+  administrator role: administrator access
+  at least the Owner role: the Owner role
+  can login: can log in
+  can log-in: can log in
+  can setup: can set up
+  can signin: can sign in
+  can sign-in: can sign in
+  codequality: code quality
+  Customer [Pp]ortal: Customers Portal
+  developer access: the Developer role
+  developer permission: the Developer role
+  developer permissions: the Developer role
+  disallow: prevent
+  frontmatter: front matter
+  GitLab self hosted: GitLab self-managed # https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#gitlab-self-managed
+  GitLab self-hosted: GitLab self-managed # https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#gitlab-self-managed
+  GitLabber: GitLab team member
+  GitLabbers: GitLab team members
+  GitLab-shell: GitLab Shell
+  gitlab omnibus: Linux package
+  golang: Go
+  guest access: the Guest role
+  guest permission: the Guest role
+  guest permissions: the Guest role
+  maintainer access: the Maintainer role
+  maintainer permission: the Maintainer role
+  maintainer permissions: the Maintainer role
+  owner access: the Owner role
+  owner permission: the Owner role
+  owner permissions: the Owner role
+  param: parameter
+  params: parameters
+  pg: PostgreSQL
+  'postgres$': PostgreSQL
+  raketask: Rake task
+  raketasks: Rake tasks
+  rspec: RSpec
+  reporter access: the Reporter role
+  reporter permission: the Reporter role
+  reporter permissions: the Reporter role
+  rubocop: RuboCop
+  self hosted GitLab: GitLab self-managed # https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#gitlab-self-managed
+  self-hosted GitLab: GitLab self-managed # https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#gitlab-self-managed
+  styleguide: style guide
+  the administrator access level: administrator access
+  to login: to log in
+  to log-in: to log in
+  to setup: to set up
+  to signin: to sign in
+  to sign-in: to sign in
+  x509: X.509
+  yml: YAML

doc/.vale/gitlab/TabsLinks.yml

+---
+# 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=.*?\)'

doc/.vale/gitlab/ToDo.yml

+---
+# Warning: gitlab.ToDo
+#
+# You should not use "To Do", unless it refers to the UI element.
+#
+# For a list of all options, see https://vale.sh/docs/topics/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/word_list.html#to-do-item
+level: warning
+ignorecase: false
+swap:
+  '[Tt]o [Dd]o [Ii]tems?': to-do item
+  '\w* [Aa] [Tt]o [Dd]o': Add a to do

doc/.vale/gitlab/UnclearAntecedent.yml

+---
+# Warning: gitlab.UnclearAntecedent
+#
+# Checks for words that need a noun for clarity.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Instead of '%s', try starting this sentence with a specific subject and verb."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#this-these-that-those
+level: warning
+ignorecase: false
+tokens:
+  - 'That is'
+  - 'That was'
+  - 'These are'
+  - 'These were'
+  - 'There are'
+  - 'There were'
+  - 'This is'
+  - 'This was'
+  - 'Those are'
+  - 'Those were'

doc/.vale/gitlab/Units.yml

+---
+# Warning: gitlab.Units
+#
+# Recommends a space between a number and a unit of measure.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Add a space between the number and the unit in '%s'."
+link: 'https://docs.gitlab.com/ee/development/documentation/styleguide/'
+nonword: true
+level: warning
+ignorecase: true
+tokens:
+  - \d+(?:B|kB|KiB|MB|MiB|GB|GiB|TB|TiB)
+  - \d+(?:ns|ms|μs|s|min|h|d)

doc/.vale/gitlab/Uppercase.yml

+---
+# 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, 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/vale.html#vale-uppercase-acronym-test
+level: suggestion
+ignorecase: false
+# Ensures that the existence of 'first' implies the existence of 'second'.
+first: '\b([A-Z]{3,5})\b'
+second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
+# ... with the exception of these:
+exceptions:
+  - ACL
+  - AJAX
+  - ALL
+  - AMI
+  - ANSI
+  - APAC
+  - API
+  - APM
+  - ARM
+  - ARN
+  - ASCII
+  - ASG
+  - AST
+  - AWS
+  - BETA
+  - BMP
+  - BSD
+  - CAS
+  - CDN
+  - CGI
+  - CIDR
+  - CLI
+  - CNA
+  - CNCF
+  - CORE
+  - CORS
+  - CPU
+  - CRAN
+  - CRIME
+  - CRM
+  - CRUD
+  - CSRF
+  - CSS
+  - CSV
+  - CTE
+  - CVE
+  - CVS
+  - CVSS
+  - CWE
+  - DAG
+  - DAST
+  - DDL
+  - DHCP
+  - DML
+  - DNS
+  - DSN
+  - DOM
+  - DORA
+  - DSA
+  - DSL
+  - DUOPRO
+  - DUOENT
+  - DVCS
+  - DVD
+  - EBS
+  - ECDSA
+  - ECS
+  - EFS
+  - EKS
+  - ELB
+  - ENA
+  - EOL
+  - EWM
+  - EXIF
+  - FAQ
+  - FIDO
+  - FIFO
+  - FIPS
+  - FLAG
+  - FOSS
+  - FQDN
+  - FREE
+  - FTP
+  - GCP
+  - GDK
+  - GDPR
+  - GET
+  - GID
+  - GIF
+  - GKE
+  - GLEX
+  - GLFM
+  - GNU
+  - GPG
+  - GPL
+  - GPS
+  - GPT
+  - GPU
+  - GUI
+  - HAML
+  - HAR
+  - HDD
+  - HEAD
+  - HIPAA
+  - HLL
+  - HSTS
+  - HTML
+  - HTTP
+  - HTTPS
+  - IAM
+  - IANA
+  - IBM
+  - ICO
+  - IDE
+  - IID
+  - IIS
+  - IMAP
+  - IOPS
+  - IRC
+  - ISO
+  - JPEG
+  - JPG
+  - JSON
+  - JVM
+  - JWT
+  - KICS
+  - LAN
+  - LDAP
+  - LDAPS
+  - LESS
+  - LFS
+  - LRU
+  - LSIF
+  - LTM
+  - LTS
+  - LVM
+  - MIME
+  - MIT
+  - MITRE
+  - MVC
+  - NAS
+  - NAT
+  - NDA
+  - NFS
+  - NGINX
+  - NOTE
+  - NPM
+  - NTP
+  - OCI
+  - OIDC
+  - OKD
+  - OKR
+  - ONLY
+  - OSS
+  - OTP
+  - OWASP
+  - PAT
+  - PCI-DSS
+  - PDF
+  - PEM
+  - PEP
+  - PGP
+  - PHP
+  - PID
+  - PKCS
+  - PNG
+  - POSIX
+  - POST
+  - PROXY
+  - PUT
+  - QPS
+  - RAID
+  - RAM
+  - RBAC
+  - RDP
+  - RDS
+  - RDS
+  - REST
+  - RFC
+  - RHEL
+  - RPC
+  - RPM
+  - RPO
+  - RPS
+  - RSA
+  - RSS
+  - RTC
+  - RTO
+  - RVM
+  - SAAS
+  - SAML
+  - SAN
+  - SAST
+  - SATA
+  - SBOM
+  - SBT
+  - SCIM
+  - SCM
+  - SCP
+  - SCSS
+  - SDK
+  - SELF
+  - SEO
+  - SFTP
+  - SHA
+  - SKI
+  - SLA
+  - SLI
+  - SLO
+  - SMS
+  - SMTP
+  - SOAP
+  - SOC
+  - SOX
+  - SPDX
+  - SPDY
+  - SPF
+  - SQL
+  - SRE
+  - SSD
+  - SSG
+  - SSH
+  - SSL
+  - SSO
+  - STI
+  - SUSE
+  - SVG
+  - SVN
+  - TCP
+  - TIFF
+  - TIP
+  - TLD
+  - TLS
+  - TODO
+  - TOML
+  - TOTP
+  - TPS
+  - TTL
+  - UBI
+  - UDP
+  - UID
+  - UID
+  - UNIX
+  - URI
+  - URL
+  - USB
+  - UTC
+  - UTF
+  - UUID
+  - VCS
+  - VPC
+  - VPN
+  - WAF
+  - WEBP
+  - WIP
+  - WSL
+  - XML
+  - XSS
+  - YAML
+  - ZAP
+  - ZIP

doc/.vale/gitlab/Wordy.yml

+---
+# Suggestion: gitlab.Wordy
+#
+# Suggests shorter versions of wordy phrases.
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: substitution
+message: "%s"
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
+level: suggestion
+ignorecase: true
+swap:
+  a number of: "Specify the number or remove the phrase."
+  as well as: "Use 'and' instead of 'as well as'."
+  note that: "Remove the phrase 'note that'."
+  please: "Use 'please' only if we've inconvenienced the user."
+  respectively: "Remove 'respectively' and list each option instead."
+  and so on: "Remove 'and so on'. Try to use 'like' and provide examples instead."
+  in order to: "Remove 'in order' and leave 'to'."

doc/.vale/gitlab/Zip.yml

+---
+# Warning: gitlab.Zip
+#
+# Recommends all instances of something.zip be wrapped in backticks
+# due to the .zip top-level domain
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: existence
+message: "Wrap '%s' in backticks to prevent unintentional links to .zip domain names."
+link: 'https://docs.gitlab.com/ee/development/documentation/styleguide/index.md#backticks-in-markdown'
+nonword: true
+level: error
+ignorecase: true
+tokens:
+  - '\b\w*\.zip'