diff options
Diffstat (limited to 'doc/.vale')
-rw-r--r-- | doc/.vale/gitlab/CIConfigFile.yml | 6 | ||||
-rw-r--r-- | doc/.vale/gitlab/CodeblockFences.yml | 4 | ||||
-rw-r--r-- | doc/.vale/gitlab/ElementDescriptors.yml | 2 | ||||
-rw-r--r-- | doc/.vale/gitlab/HeadingDepth.yml | 4 | ||||
-rw-r--r-- | doc/.vale/gitlab/Substitutions.yml | 1 | ||||
-rw-r--r-- | doc/.vale/gitlab/Uppercase.yml | 1 | ||||
-rw-r--r-- | doc/.vale/gitlab/spelling-exceptions.txt | 22 |
7 files changed, 27 insertions, 13 deletions
diff --git a/doc/.vale/gitlab/CIConfigFile.yml b/doc/.vale/gitlab/CIConfigFile.yml index 4d2ba454410..5cbd02e799b 100644 --- a/doc/.vale/gitlab/CIConfigFile.yml +++ b/doc/.vale/gitlab/CIConfigFile.yml @@ -10,8 +10,4 @@ link: https://docs.gitlab.com/ee/development/documentation/versions.html level: error scope: raw raw: - - '(`gitlab-ci.yml`|' - - '`gitlabci.yml`|' - - '`gitlab.ci.yml`|' - - '`.gitlab.ci-yml`|' - - '`.gitlab-ci.yaml`)' + - '(?!`\.gitlab-ci\.yml`)`.?gitlab.?ci.?ya?ml`' diff --git a/doc/.vale/gitlab/CodeblockFences.yml b/doc/.vale/gitlab/CodeblockFences.yml index 9d5efe7f60a..27159f7e72e 100644 --- a/doc/.vale/gitlab/CodeblockFences.yml +++ b/doc/.vale/gitlab/CodeblockFences.yml @@ -5,9 +5,9 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: "Instead of '%s' for the code block, use yaml, ruby, plaintext, markdown, javascript, shell, golang, python, dockerfile, or typescript." +message: "Instead of '%s' for the code block, use yaml, ruby, plaintext, markdown, javascript, shell, go, python, dockerfile, or typescript." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#code-blocks level: error scope: raw raw: - - '\`\`\`(yml|rb|text|md|bash|sh\n|js\n|go\n|py\n|docker\n|ts)' + - '\`\`\`(yml|rb|text|md|bash|sh\n|js\n|golang\n|py\n|docker\n|ts)' diff --git a/doc/.vale/gitlab/ElementDescriptors.yml b/doc/.vale/gitlab/ElementDescriptors.yml index f806f5878e1..fd3acace744 100644 --- a/doc/.vale/gitlab/ElementDescriptors.yml +++ b/doc/.vale/gitlab/ElementDescriptors.yml @@ -11,4 +11,4 @@ level: warning ignorecase: true scope: raw raw: - - \*\*.+?\*\* button + - \*\*[^*]+\*\*\s+button diff --git a/doc/.vale/gitlab/HeadingDepth.yml b/doc/.vale/gitlab/HeadingDepth.yml index 5bbe667481c..000baf633d7 100644 --- a/doc/.vale/gitlab/HeadingDepth.yml +++ b/doc/.vale/gitlab/HeadingDepth.yml @@ -6,8 +6,8 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ 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 +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#heading-levels-in-markdown level: suggestion scope: raw raw: - - '(?<=\n)#{5,}\s.*' + - '(?<=\n)#{6,}\s.*' diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index 675abc6ef6d..225e4e74880 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -23,6 +23,7 @@ swap: params: parameters pg: PostgreSQL 'postgres$': PostgreSQL + golang: Go raketask: Rake task raketasks: Rake tasks rspec: RSpec diff --git a/doc/.vale/gitlab/Uppercase.yml b/doc/.vale/gitlab/Uppercase.yml index 19e0fec6622..1948842d026 100644 --- a/doc/.vale/gitlab/Uppercase.yml +++ b/doc/.vale/gitlab/Uppercase.yml @@ -147,6 +147,7 @@ exceptions: - NPM - NTP - OCI + - OIDC - OKD - OKR - ONLY diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt index a2a23c03aa3..476b1eebf84 100644 --- a/doc/.vale/gitlab/spelling-exceptions.txt +++ b/doc/.vale/gitlab/spelling-exceptions.txt @@ -197,6 +197,7 @@ Coursier CPU CPUs CRAN +CRI-O cron crond cronjob @@ -223,6 +224,8 @@ cybersecurity CycloneDX Dangerfile DAST +Database Lab Engine +Database Lab Databricks Datadog datasource @@ -273,6 +276,8 @@ desugar desugars desynchronized Dev +devfile +devfiles DevOps Dhall dialogs @@ -290,6 +295,7 @@ Dockerfiles Dockerize Dockerized Dockerizing +Docusaurus dogfood dogfooding dogfoods @@ -325,6 +331,7 @@ ETag ETags Etsy Excon +exfiltrate exfiltration ExifTool expirable @@ -390,6 +397,8 @@ Gitter GLab globals globbing +globstar +globstars Gmail Godep Golang @@ -431,6 +440,7 @@ hotfixed hotfixes hotfixing hotspots +HTMLHint http https hyperparameter @@ -495,6 +505,7 @@ Kibana Kinesis Klar Knative +KPIs Kramdown Kroki kubeconfig @@ -574,7 +585,7 @@ mitigations mitmproxy mixin mixins -MLFlow +MLflow Mmap mockup mockups @@ -615,6 +626,7 @@ Nurtch NVMe nyc OAuth +OCP Octokit offboarded offboarding @@ -623,6 +635,7 @@ OIDs OKRs OKRs Okta +OLM OmniAuth onboarding OpenID @@ -666,6 +679,7 @@ Pipfile Pipfiles Piwik plaintext +podman Poedit polyfill polyfills @@ -833,8 +847,8 @@ sanitization SBOMs sbt SBT -scalers scalar's +scalers scatterplot scatterplots schedulable @@ -1049,6 +1063,7 @@ unencoded unencoder unencodes unencrypted +unescaped unfollow unfollowed unfollows @@ -1068,6 +1083,7 @@ unoptimize unoptimized unoptimizes unoptimizing +unparsable unpatched unpause unprioritized @@ -1182,7 +1198,7 @@ ZAProxy Zeitwerk Zendesk ZenTao +Zoekt zsh Zstandard Zuora -Zoekt |