Merge branch 'eread/update-linting-configuration-from-gitlab-project-docs' into 'main'

Update linting configuration from GitLab project

See merge request https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/6352

Merged-by: Marcel Amirault <mamirault@gitlab.com>
Approved-by: Marcel Amirault <mamirault@gitlab.com>
Co-authored-by: Evan Read <eread@gitlab.com>

Author: Ravlen

.markdownlint-cli2.yaml

@@ -71,7 +71,9 @@ config:
       "Git",
       "Gitaly",
       "GitHub",
+      "gitlab-duo",
       "gitlab.vim",
+      "GitLab chart",
       "GitLab Geo",
       "GitLab Monitor",
       "GitLab Operator",
@@ -149,6 +151,7 @@ config:
       "SpotBugs",
       "SSH",
       "Tiller",
+      "Tiptap",
       "TOML",
       "Trello",
       "Trello Power-Ups",

docs/.vale/gitlab_base/British.yml

@@ -37,6 +37,9 @@ swap:
   civilise: civilize
   colour: color
   cosy: cozy
+  customise: customize
+  customised: customized
+  customising: customizing
   cypher: cipher
   dependant: dependent
   defence: defense
@@ -61,6 +64,9 @@ swap:
   honour: honor
   initialled: initialed
   initialling: initialing
+  initialise: initialize
+  initialised: initialized
+  initialising: initializing
   instil: instill
   jewellery: jewelry
   labelling: labeling

docs/.vale/gitlab_base/ListIndentation.yml

@@ -3,7 +3,7 @@ name: gitlab_base.ListIndentation
 description: |
   Ensures content nested in lists is spaced correctly.
 extends: existence
-message: "Items nested under an ordered list must be indented three spaces. Items nested under an unordered list must be indented two spaces."
+message: "Text or new list items nested under an ordered list must be indented three spaces, and indented two spaces for an unordered list."
 link: https://docs.gitlab.com/development/documentation/styleguide/#nesting-inside-a-list-item
 vocab: false
 level: error
@@ -13,6 +13,7 @@ scope: raw
 tokens:
   - '^1\. [^\n]*\n\n?( |  |    )[`\w-]'
   - '^- [^\n]*\n\n?( |   |    )[`\w-]'
+  - '^1\..*\n[a-zA-Z\[]'
 
 # Regex guide:
 #

docs/.vale/gitlab_base/PossessiveProperNouns.yml

@@ -23,7 +23,7 @@ tokens:
   - Google Cloud's
   - Google's
   - Microsoft's
-  - Nvidia's
+  - NVIDIA's
   - Oracle's
   - Red Hat's
   - RSpec's

docs/.vale/gitlab_base/SubstitutionWarning.yml

@@ -3,7 +3,7 @@ name: gitlab_base.SubstitutionWarning
 description: |
   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.
 extends: substitution
-message: "Use '%s' instead of '%s' when possible."
+message: "Use '%s' instead of '%s'."
 link: https://docs.gitlab.com/development/documentation/styleguide/word_list/
 vocab: false
 level: warning
@@ -34,6 +34,8 @@ swap:
   dialog box: "dialog"
   distro: "distribution"
   docs: "documentation"
+  (?<!GitLab )(?<!Cisco )(?<!Fix (pipeline )?with )(?<!Generate MR with )Duo: "GitLab Duo"
+  DAP: "GitLab Duo Agent Platform"
   e-mail: "email"
   emojis: "emoji"
   ex: "for example"

docs/.vale/gitlab_base/spelling-exceptions.txt

@@ -2,6 +2,7 @@ accessor
 accessors
 ACLs
 Adafruit
+agentic
 Agentic
 Airbnb
 Airtable
@@ -105,6 +106,7 @@ Bootsnap
 bot
 bot's
 Bottlerocket
+Brevo
 browsable
 bugfix
 bugfixed
@@ -137,6 +139,7 @@ captcha
 CAPTCHAs
 Capybara
 Casdoor
+Ccache
 CDNs
 CE
 CentOS
@@ -174,12 +177,15 @@ CMKs
 CNAs
 CNs
 Cobertura
+CocoaPods
 Codeberg
 Codeception
 Codecov
+codemods
 codenames
 Codepen
 CodeSandbox
+Codestral
 Codey
 Cognito
 Coinbase
@@ -198,6 +204,7 @@ Conda
 config
 Configs
 Consul
+containerd
 Contentful
 Corosync
 corpuses
@@ -417,6 +424,7 @@ gitlabsos
 Gitleaks
 Gitpod
 Gitter
+glab
 GLab
 globals
 globbing
@@ -437,6 +445,7 @@ Gradle
 Grafana
 Grafonnet
 gravatar
+Grayson
 Grype
 GUIs
 Gzip
@@ -449,6 +458,7 @@ hardcoded
 hardcodes
 HashiCorp
 Haswell
+Heartbleed
 heatmap
 heatmaps
 Helm
@@ -475,6 +485,7 @@ iCalendar
 iCloud
 IDE's
 idempotence
+idempotency
 IDEs
 idmapper
 Iglu
@@ -507,6 +518,7 @@ Javafuzz
 JavaScript
 Jenkins
 Jenkinsfile
+JFrog
 Jira
 Jitsu
 jq
@@ -548,6 +560,7 @@ Kroki
 kubeconfig
 Kubecost
 kubectl
+Kubelet
 Kubernetes
 Kubesec
 Kucoin
@@ -563,6 +576,7 @@ ldapsearch
 Lefthook
 Leiningen
 Lemmy
+Libbehave
 libFuzzer
 Libgcrypt
 Libravatar
@@ -638,6 +652,7 @@ mitmproxy
 mixin
 mixins
 MLflow
+MLOps
 Mmap
 mockup
 mockups
@@ -677,6 +692,7 @@ NuGet
 nullability
 nullable
 Nurtch
+NVIDIA
 NVMe
 nyc
 OAuth
@@ -691,6 +707,7 @@ Okta
 Ollama
 OLM
 OmniAuth
+Ona
 onboarding
 OpenID
 OpenShift
@@ -739,6 +756,7 @@ Pipfile
 Pipfiles
 Piwik
 plaintext
+pnpm
 podman
 Poedit
 polyfill
@@ -774,6 +792,7 @@ prepopulate
 prepopulated
 presentationals
 Prettifier
+Prioritizer
 Pritaly
 Priyanka
 profiler
@@ -787,11 +806,13 @@ proxyable
 proxying
 pseudocode
 pseudonymization
+pseudonymize
 pseudonymized
 pseudonymizer
 Pulumi
 Puma
 Pumble
+Pydantic
 Pylint
 PyPI
 pytest
@@ -935,6 +956,7 @@ SFCs
 sharded
 sharding
 SHAs
+Shellshock
 shfmt
 Shippo
 Shopify
@@ -1052,11 +1074,13 @@ syslog
 systemd
 tablespace
 tablespaces
+Tailscale
 Tamland
 tanuki
 taskscaler
 tcpdump
 teardown
+Telesign
 templated
 Thanos
 thoughtbot
@@ -1082,6 +1106,7 @@ toolkits
 toolset
 tooltip
 tooltips
+Traefik
 transactionally
 transpile
 transpiled
@@ -1209,6 +1234,7 @@ untarred
 untrack
 untracked
 untrusted
+unvalidated
 unverified
 unverifies
 unverify

docs/.vale/gitlab_docs/AlertBoxStyle.yml

@@ -0,0 +1,14 @@
+---
+name: gitlab_docs.HTMLShortcodes
+description: |
+  If HTML code is immediately followed by Hugo shortcodes, add a newline between them.
+extends: existence
+message: "If HTML code is immediately followed by Hugo shortcodes, add a newline between them."
+link: https://docs.gitlab.com/development/documentation/styleguide/#shortcodes
+vocab: false
+ignorecase: true
+level: error
+nonword: true
+scope: raw
+tokens:
+  - '>\n\{\{<'

docs/.vale/gitlab_docs/HTMLShortcodes.yml

@@ -11,5 +11,4 @@ nonword: true
 scope: raw
 tokens:
   - '\{\{< history >\}\}\n\n[^-]'
-  - '(^#+[^\n]*|\{\{< /details >\}\})\n\n>'
   - '^##.*?\n\n- \[?(Introduced|Changed|Renamed|Updated|Improved|Generally)'