Update Vale rules after linting https://grafana.com/docs/grafana/next…

…/setup-grafana/configure-grafana/ (#978)
grafana · Jan 20, 2025 · 856d54a · 856d54a
1 parent b6892ce
commit 856d54a
Show file tree

Hide file tree

Showing 22 changed files with 108 additions and 20 deletions.
diff --git a/.github/workflows/validate-documentation.yml b/.github/workflows/validate-documentation.yml
@@ -20,6 +20,7 @@ jobs:
           docs/sources
           /docs/writers-toolkit
           | grep -v sources/shared
+          | grep -v anchorize.inline
           | reviewdog
           -f=rdjsonl
           --fail-on-error

diff --git a/docs/sources/review/lint-prose/rules.md b/docs/sources/review/lint-prose/rules.md
@@ -2,7 +2,7 @@
 date: "2024-06-25"
 description: A description of every Grafana Labs prose linting rule.
 menuTitle: Rules
-review_date: "2025-01-15"
+review_date: "2025-01-16"
 title: Vale rules
 ---
 
@@ -748,12 +748,17 @@ Instead, use the name as a modifier or rewrite to use a word like of to indicate
 
 _`<CURRENT TEXT>`_ was matched by one or more of the following regular expressions:
 
+- `ADOT's`
 - `AI Observability's`
 - `Agent's`
 - `Alloy's`
+- `ARN's`
 - `Asserts'`
 - `AWS's`
+- `AWS Distro for OpenTelemetry Collector's`
+- `AWS X-Ray's`
 - `Beyla's`
+- `BoringCrypto's`
 - `CentOS's`
 - `CloudWatch's`
 - `Codespaces'`
@@ -763,25 +768,32 @@ _`<CURRENT TEXT>`_ was matched by one or more of the following regular expressio
 - `Dynatrace's`
 - `EKS's`
 - `Elastic Kubernetes Service's`
+- `Entra's`
 - `Firehose's`
+- `FreeBSD's`
 - `GEM's`
 - `GKE's`
 - `Git's`
 - `GitHub's`
+- `GitLab's`
 - `GNU's`
 - `Grafana's`
 - `Gravatar's`
 - `Graylog's`
+- `hashmod's`
 - `IBM's`
 - `Jaeger's`
 - `Jira's`
+- `journald's`
 - `Jsonnet's`
 - `Kibana's`
 - `Killercoda's`
 - `Kinesis'`
 - `Kubernetes'`
 - `Kubernetes Engine's`
+- `Kustomize's`
 - `LangChain's`
+- `launchd's`
 - `Loki's`
 - `Markdown's`
 - `Memcached's`
@@ -801,6 +813,7 @@ _`<CURRENT TEXT>`_ was matched by one or more of the following regular expressio
 - `Podman's`
 - `Postgres'`
 - `PostgreSQL's`
+- `pprof's`
 - `Prometheus'`
 - `Promtail's`
 - `Pyroscope's`
@@ -809,8 +822,12 @@ _`<CURRENT TEXT>`_ was matched by one or more of the following regular expressio
 - `Relational Database Service's`
 - `React's`
 - `Redis'`
+- `RHEL's`
 - `Rollup's`
+- `RudderStack's`
 - `Splunk's`
+- `SSM's`
+- `SUSE's`
 - `Tempo's`
 - `Thanos'`
 - `Velero's`
@@ -956,15 +973,17 @@ Use _`<REPLACEMENT TEXT>`_ instead of _`<CURRENT TEXT>`_.
 | `(?:SHA-1\|HAS-SHA1)`                                             | `SHA-1`                    |
 | `(?:WiFi\|wifi)`                                                  | `Wi-Fi`                    |
 | `(?:[Oo]penshift\|openShift)`                                     | `OpenShift`                |
-| `(?:[gG]itHub]\|Github)`                                          | `GitHub`                   |
+| `(?:[eE]-mail)`                                                   | `email`                    |
 | `(?:[oO]pentelemetry\|openTelemetry)`                             | `OpenTelemetry`            |
 | `(?:alert[Mm]anager\|[Aa]lert [Mm]anager\|AlertManager)`          | `Alertmanager`             |
 | `(?:cell ?phone\|smart ?phone)`                                   | `phone\|mobile phone`      |
 | `(?:content\|media)-?type`                                        | `media type`               |
-| `(?:e-mail\|Email\|E-mail)`                                       | `email`                    |
 | `(?:file ?path\|path ?name)`                                      | `path`                     |
 | `(?:file ?path\|path ?name)s`                                     | `paths`                    |
+| `(?:github\|gitHub\|Github)`                                      | `GitHub`                   |
+| `(?:gitlab\|gitLab\|Gitlab)`                                      | `GitLab`                   |
 | `(?:hamburger menu\|kebab menu)`                                  | `menu icon`                |
+| `(?:java[Ss]cript\|Javascript)`                                   | `JavaScript`               |
 | `(?:kill\|terminate\|abort)`                                      | `stop\|exit\|cancel\|end`  |
 | `(?<!kube-)prometheus`                                            | `Prometheus`               |
 | `(?<!lambda-)promtail`                                            | `Promtail`                 |
@@ -973,6 +992,7 @@ Use _`<REPLACEMENT TEXT>`_ instead of _`<CURRENT TEXT>`_.
 | `HTTPs`                                                           | `HTTPS`                    |
 | `Once`                                                            | `After`                    |
 | `RCA Workbench`                                                   | `RCA workbench`            |
+| `Rudderstack`                                                     | `RudderStack`              |
 | `VMWare`                                                          | `VMware`                   |
 | `Vmware`                                                          | `VMware`                   |
 | `[Ww]orld [Ww]ide [Ww]eb`                                         | `web`                      |
@@ -1019,6 +1039,7 @@ Use _`<REPLACEMENT TEXT>`_ instead of _`<CURRENT TEXT>`_.
 | `network IP address`                                              | `internal IP address`      |
 | `open-source`                                                     | `open source`              |
 | `otel`                                                            | `OTel`                     |
+| `otlp`                                                            | `OTLP`                     |
 | `phlare`                                                          | `Phlare`                   |
 | `postgres`                                                        | `Postgres`                 |
 | `postgresql`                                                      | `PostgreSQL`               |
@@ -1029,6 +1050,7 @@ Use _`<REPLACEMENT TEXT>`_ instead of _`<CURRENT TEXT>`_.
 | `repo`                                                            | `repository`               |
 | `repos`                                                           | `repositories`             |
 | `right[- ]hand[- ]side`                                           | `right-side`               |
+| `rudderstack`                                                     | `RudderStack`              |
 | `sign into`                                                       | `sign in to`               |
 | `sqlite`                                                          | `SQLite`                   |
 | `style sheet`                                                     | `stylesheet`               |

diff --git a/docs/sources/review/test-documentation-changes/index.md b/docs/sources/review/test-documentation-changes/index.md
@@ -23,7 +23,7 @@ To run the local documentation web server, ensure that you are in the right dire
 {{< /admonition >}}
 
 The output message of a successful build includes a URL that you can follow to view the changes to the documentation in the browser.
-Refer to an [example of a successful build](#example-succesful-build).
+Refer to an [example of a successful build](#example-successful-build).
 
 ## Run with specific projects
 

diff --git a/vale/Grafana/styles/Grafana/Acronyms.yml b/vale/Grafana/styles/Grafana/Acronyms.yml
@@ -1,17 +1,22 @@
 "exceptions":
+  - "ADOT"
   - "API"
   - "APT"
+  - "ARN"
   - "AWS"
   - "BPF"
   - "CLI"
   - "CORS"
   - "CPU"
+  - "CRD"
   - "CSS"
   - "CSV"
+  - "DNS"
   - "DOM"
   - "eBPF"
   - "FAQ"
   - "GNU"
+  - "GPG"
   - "GPU"
   - "GUI"
   - "HTML"
@@ -24,6 +29,7 @@
   - "JSON"
   - "JSX"
   - "LESS"
+  - "NAT"
   - "OSS"
   - "OTLP"
   - "PDF"
@@ -32,6 +38,7 @@
   - "RAM"
   - "RBAC"
   - "REPL"
+  - "RHEL"
   - "RPM"
   - "RSA"
   - "SCM"
@@ -41,9 +48,11 @@
   - "SHA-1"
   - "SQL"
   - "SSD"
+  - "SSM"
   - "SSH"
   - "SSL"
   - "SSO"
+  - "SUSE"
   - "SVG"
   - "TCP"
   - "TLS"

diff --git a/vale/Grafana/styles/Grafana/AmazonProductNames.yml b/vale/Grafana/styles/Grafana/AmazonProductNames.yml
@@ -1,7 +1,7 @@
 "extends": "conditional"
-"first": "\\b(CloudWatch|Data Firehose|Elastic Kubernetes Service|Firehose|Kinesis|Relational Database Service)\\b"
+"first": "\\b(ARN|AWS Distro for OpenTelemetry Collector|AWS X-Ray|CloudWatch|Data Firehose|Elastic Kubernetes Service|Firehose|Kinesis|Relational Database Service|SSM)\\b"
 "level": "warning"
 "link": "https://grafana.com/docs/writers-toolkit/write/style-guide/capitalization-punctuation/#amazon-products"
 "message": "Use the full Amazon product name in the first instance."
 "scope": "text"
-"second": "Amazon (CloudWatch|Data Firehose|Elastic Kubernetes Service|Firehose|Kinesis|Relational Database Service)"
+"second": "Amazon (ARN|AWS Distro for OpenTelemetry Collector|AWS X-Ray|CloudWatch|Data Firehose|Elastic Kubernetes Service|Firehose|Kinesis|Relational Database Service|SSM)"
diff --git a/vale/Grafana/styles/Grafana/Headings.yml b/vale/Grafana/styles/Grafana/Headings.yml
@@ -29,12 +29,14 @@
   - "Dynatrace"
   - "EKS"
   - "Elastic Kubernetes Service"
+  - "Entra"
   - "Firehose"
   - "FreeBSD"
   - "GEM"
   - "GKE"
   - "Git"
   - "GitHub"
+  - "GitLab"
   - "GNU"
   - "Grafana"
   - "Gravatar"
@@ -83,6 +85,7 @@
   - "Redis"
   - "RHEL"
   - "Rollup"
+  - "RudderStack"
   - "Splunk"
   - "SSM"
   - "SUSE"
@@ -105,6 +108,7 @@
   - "CLA"
   - "CLI"
   - "CLS"
+  - "CMS"
   - "CORS"
   - "CPU"
   - "CRD"
@@ -127,6 +131,7 @@
   - "HTTP"
   - "HTTPS"
   - "IBM"
+  - "ICU"
   - "IDE"
   - "JAR"
   - "JPG"
@@ -210,6 +215,7 @@
   - "HyperText Markup Language"
   - "HyperText Transfer Protocol"
   - "HyperText Transfer Protocol Secure"
+  - "International Components for Unicode"
   - "Kubernetes-based Event-Driven Autoscaling"
   - "Largest Contentful Paint"
   - "Leaner Style Sheets"

diff --git a/vale/Grafana/styles/Grafana/ProductPossessives.yml b/vale/Grafana/styles/Grafana/ProductPossessives.yml
@@ -5,12 +5,17 @@
   Don't form a possessive from a feature name, product name, or trademark, regardless of who owns it.
   Instead, use the name as a modifier or rewrite to use a word like of to indicate the relationship.
 "tokens":
+  - "ADOT's"
   - "AI Observability's"
   - "Agent's"
   - "Alloy's"
+  - "ARN's"
   - "Asserts'"
   - "AWS's"
+  - "AWS Distro for OpenTelemetry Collector's"
+  - "AWS X-Ray's"
   - "Beyla's"
+  - "BoringCrypto's"
   - "CentOS's"
   - "CloudWatch's"
   - "Codespaces'"
@@ -20,25 +25,32 @@
   - "Dynatrace's"
   - "EKS's"
   - "Elastic Kubernetes Service's"
+  - "Entra's"
   - "Firehose's"
+  - "FreeBSD's"
   - "GEM's"
   - "GKE's"
   - "Git's"
   - "GitHub's"
+  - "GitLab's"
   - "GNU's"
   - "Grafana's"
   - "Gravatar's"
   - "Graylog's"
+  - "hashmod's"
   - "IBM's"
   - "Jaeger's"
   - "Jira's"
+  - "journald's"
   - "Jsonnet's"
   - "Kibana's"
   - "Killercoda's"
   - "Kinesis'"
   - "Kubernetes'"
   - "Kubernetes Engine's"
+  - "Kustomize's"
   - "LangChain's"
+  - "launchd's"
   - "Loki's"
   - "Markdown's"
   - "Memcached's"
@@ -58,6 +70,7 @@
   - "Podman's"
   - "Postgres'"
   - "PostgreSQL's"
+  - "pprof's"
   - "Prometheus'"
   - "Promtail's"
   - "Pyroscope's"
@@ -66,8 +79,12 @@
   - "Relational Database Service's"
   - "React's"
   - "Redis'"
+  - "RHEL's"
   - "Rollup's"
+  - "RudderStack's"
   - "Splunk's"
+  - "SSM's"
+  - "SUSE's"
   - "Tempo's"
   - "Thanos'"
   - "Velero's"

diff --git a/vale/Grafana/styles/Grafana/WordList.yml b/vale/Grafana/styles/Grafana/WordList.yml
@@ -10,15 +10,17 @@
   "(?:SHA-1|HAS-SHA1)": "SHA-1"
   "(?:WiFi|wifi)": "Wi-Fi"
   "(?:[Oo]penshift|openShift)": "OpenShift"
-  "(?:[gG]itHub]|Github)": "GitHub"
+  "(?:[eE]-mail)": "email"
   "(?:[oO]pentelemetry|openTelemetry)": "OpenTelemetry"
   "(?:alert[Mm]anager|[Aa]lert [Mm]anager|AlertManager)": "Alertmanager"
   "(?:cell ?phone|smart ?phone)": "phone|mobile phone"
   "(?:content|media)-?type": "media type"
-  "(?:e-mail|Email|E-mail)": "email"
   "(?:file ?path|path ?name)": "path"
   "(?:file ?path|path ?name)s": "paths"
+  "(?:github|gitHub|Github)": "GitHub"
+  "(?:gitlab|gitLab|Gitlab)": "GitLab"
   "(?:hamburger menu|kebab menu)": "menu icon"
+  "(?:java[Ss]cript|Javascript)": "JavaScript"
   "(?:kill|terminate|abort)": "stop|exit|cancel|end"
   "(?<!kube-)prometheus": "Prometheus"
   "(?<!lambda-)promtail": "Promtail"
@@ -27,6 +29,7 @@
   "HTTPs": "HTTPS"
   "Once": "After"
   "RCA Workbench": "RCA workbench"
+  "Rudderstack": "RudderStack"
   "VMWare": "VMware"
   "Vmware": "VMware"
   "[Ww]orld [Ww]ide [Ww]eb": "web"
@@ -73,6 +76,7 @@
   "network IP address": "internal IP address"
   "open-source": "open source"
   "otel": "OTel"
+  "otlp": "OTLP"
   "phlare": "Phlare"
   "postgres": "Postgres"
   "postgresql": "PostgreSQL"
@@ -83,6 +87,7 @@
   "repo": "repository"
   "repos": "repositories"
   "right[- ]hand[- ]side": "right-side"
+  "rudderstack": "RudderStack"
   "sign into": "sign in to"
   "sqlite": "SQLite"
   "style sheet": "stylesheet"

diff --git a/vale/Grafana/styles/config/dictionaries/Makefile b/vale/Grafana/styles/config/dictionaries/Makefile
@@ -20,5 +20,5 @@ en_US-places.dic: en_US-places.wordlist
 	cat <(wc -l <$< | tr -d ' ') $< > $@
 
 en_US-grafana.dic: ## Create a Hunspell dictionary for Grafana from the Jsonnet dictionary.
-en_US-grafana.dic: en_US-grafana.jsonnet ../../../../dictionary.libsonnet $(wildcard ../../../../dictionary/*.libsonnet)
+en_US-grafana.dic: en_US-grafana.jsonnet ../../../../dictionary.libsonnet $(wildcard ../../../../dictionary/*.jsonnet)
 	jsonnet -S en_US-grafana.jsonnet > $@
-Original file line number
+Diff line change
@@ -1,17 +1,22 @@
     "exceptions":
+      - "ADOT"
       - "API"
       - "APT"
+      - "ARN"
       - "AWS"
       - "BPF"
       - "CLI"
       - "CORS"
       - "CPU"
+      - "CRD"
       - "CSS"
       - "CSV"
+      - "DNS"
       - "DOM"
       - "eBPF"
       - "FAQ"
       - "GNU"
+      - "GPG"
       - "GPU"
       - "GUI"
       - "HTML"
@@ Expand All / @@ -24,6 +29,7 @@ @@
       - "JSON"
       - "JSX"
       - "LESS"
+      - "NAT"
       - "OSS"
       - "OTLP"
       - "PDF"
@@ Expand All / @@ -32,6 +38,7 @@ @@
       - "RAM"
       - "RBAC"
       - "REPL"
+      - "RHEL"
       - "RPM"
       - "RSA"
       - "SCM"
@@ Expand All / @@ -41,9 +48,11 @@ @@
       - "SHA-1"
       - "SQL"
       - "SSD"
+      - "SSM"
       - "SSH"
       - "SSL"
       - "SSO"
+      - "SUSE"
       - "SVG"
       - "TCP"
       - "TLS"
@@ Expand Down @@