diff --git a/docs/sources/review/lint-prose/rules.md b/docs/sources/review/lint-prose/rules.md index 9bb808435..2ab8039e8 100755 --- 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-02-07" +review_date: "2025-02-14" title: Vale rules --- @@ -827,7 +827,9 @@ _``_ was matched by one or more of the following regular expressio - `OpenAI's` - `OpenShift's` - `OpenTelemetry's` +- `Opsgenie's` - `OTel's` +- `PagerDuty's` - `Parca's` - `Phlare's` - `Pinecone's` @@ -846,14 +848,18 @@ _``_ was matched by one or more of the following regular expressio - `RHEL's` - `Rollup's` - `RudderStack's` +- `Sensu's` +- `Sensu Go's` - `Splunk's` - `SSM's` - `SUSE's` - `Tempo's` - `Thanos'` +- `Threema's` - `Velero's` - `Vite's` - `VMware's` +- `Webex's` - `WildFly's` - `windows_exporter's` - `Zipkin's` @@ -1014,6 +1020,7 @@ Use _``_ instead of _``_. | `Influx[Dd]b` | `InfluxDB` | | `Influxd[Bb]` | `InfluxDB` | | `Once` | `After` | +| `Pagerduty` | `PagerDuty` | | `RCA Workbench` | `RCA workbench` | | `Rudderstack` | `RudderStack` | | `VMWare` | `VMware` | @@ -1067,6 +1074,7 @@ Use _``_ instead of _``_. | `open-source` | `open source` | | `otel` | `OTel` | | `otlp` | `OTLP` | +| `pager[dD]uty` | `PagerDuty` | | `phlare` | `Phlare` | | `postgres` | `Postgres` | | `postgresql` | `PostgreSQL` | @@ -1078,6 +1086,7 @@ Use _``_ instead of _``_. | `repos` | `repositories` | | `right[- ]hand[- ]side` | `right-side` | | `rudderstack` | `RudderStack` | +| `sensu` | `Sensu` | | `sign into` | `sign in to` | | `sqlite` | `SQLite` | | `style sheet` | `stylesheet` | @@ -1088,6 +1097,7 @@ Use _``_ instead of _``_. | `tempo` | `Tempo` | | `the Grafana Agent` | `Grafana Agent` | | `the RCA [Ww]orkbench` | `RCA workbench` | +| `threema` | `Threema` | | `timeseries` | `time series\|time-series` | | `trace(?:ql\|QL)` | `TraceQL` | | `un(?:check\|select)` | `clear` | @@ -1095,6 +1105,7 @@ Use _``_ instead of _``_. | `urls` | `URLs` | | `vmware` | `VMware` | | `vs\.` | `versus` | +| `webex` | `Webex` | | `whitelist` | `allowlist` | | `whitelisted` | `allowlisted` | | `whitelisting` | `allowlisting` | diff --git a/vale/Grafana/styles/Grafana/Headings.yml b/vale/Grafana/styles/Grafana/Headings.yml index b102ee8f7..a0840b683 100644 --- a/vale/Grafana/styles/Grafana/Headings.yml +++ b/vale/Grafana/styles/Grafana/Headings.yml @@ -71,7 +71,9 @@ - "OpenAI" - "OpenShift" - "OpenTelemetry" + - "Opsgenie" - "OTel" + - "PagerDuty" - "Parca" - "Phlare" - "Pinecone" @@ -90,14 +92,18 @@ - "RHEL" - "Rollup" - "RudderStack" + - "Sensu" + - "Sensu Go" - "Splunk" - "SSM" - "SUSE" - "Tempo" - "Thanos" + - "Threema" - "Velero" - "Vite" - "VMware" + - "Webex" - "WildFly" - "windows_exporter" - "Zipkin" diff --git a/vale/Grafana/styles/Grafana/ProductPossessives.yml b/vale/Grafana/styles/Grafana/ProductPossessives.yml index be7fa1cb6..98cd54727 100644 --- a/vale/Grafana/styles/Grafana/ProductPossessives.yml +++ b/vale/Grafana/styles/Grafana/ProductPossessives.yml @@ -69,7 +69,9 @@ - "OpenAI's" - "OpenShift's" - "OpenTelemetry's" + - "Opsgenie's" - "OTel's" + - "PagerDuty's" - "Parca's" - "Phlare's" - "Pinecone's" @@ -88,14 +90,18 @@ - "RHEL's" - "Rollup's" - "RudderStack's" + - "Sensu's" + - "Sensu Go's" - "Splunk's" - "SSM's" - "SUSE's" - "Tempo's" - "Thanos'" + - "Threema's" - "Velero's" - "Vite's" - "VMware's" + - "Webex's" - "WildFly's" - "windows_exporter's" - "Zipkin's" diff --git a/vale/Grafana/styles/Grafana/WordList.yml b/vale/Grafana/styles/Grafana/WordList.yml index 76c2f09c8..de5d9dee3 100644 --- a/vale/Grafana/styles/Grafana/WordList.yml +++ b/vale/Grafana/styles/Grafana/WordList.yml @@ -30,6 +30,7 @@ "Influx[Dd]b": "InfluxDB" "Influxd[Bb]": "InfluxDB" "Once": "After" + "Pagerduty": "PagerDuty" "RCA Workbench": "RCA workbench" "Rudderstack": "RudderStack" "VMWare": "VMware" @@ -83,6 +84,7 @@ "open-source": "open source" "otel": "OTel" "otlp": "OTLP" + "pager[dD]uty": "PagerDuty" "phlare": "Phlare" "postgres": "Postgres" "postgresql": "PostgreSQL" @@ -94,6 +96,7 @@ "repos": "repositories" "right[- ]hand[- ]side": "right-side" "rudderstack": "RudderStack" + "sensu": "Sensu" "sign into": "sign in to" "sqlite": "SQLite" "style sheet": "stylesheet" @@ -104,6 +107,7 @@ "tempo": "Tempo" "the Grafana Agent": "Grafana Agent" "the RCA [Ww]orkbench": "RCA workbench" + "threema": "Threema" "timeseries": "time series|time-series" "trace(?:ql|QL)": "TraceQL" "un(?:check|select)": "clear" @@ -111,6 +115,7 @@ "urls": "URLs" "vmware": "VMware" "vs\\.": "versus" + "webex": "Webex" "whitelist": "allowlist" "whitelisted": "allowlisted" "whitelisting": "allowlisting" diff --git a/vale/Grafana/styles/config/dictionaries/en_US-grafana.dic b/vale/Grafana/styles/config/dictionaries/en_US-grafana.dic index 3e95160cf..d230f1237 100644 --- a/vale/Grafana/styles/config/dictionaries/en_US-grafana.dic +++ b/vale/Grafana/styles/config/dictionaries/en_US-grafana.dic @@ -1,4 +1,4 @@ -343 +349 ACL/S po:noun ADOT/ po:noun AI Observability/ po:noun @@ -197,12 +197,14 @@ open source/ po:noun OpenShift/ po:noun OpenTelemetry/ po:adjective OpenTelemetry/ po:noun +Opsgenie/ po:noun OSS/ po:noun OTel/ po:adjective OTel/ po:noun OTLP/ po:noun overbill/DG po:verb overutilization/S po:noun +PagerDuty/ po:noun Parca/ po:noun path/S po:noun PDF/S po:noun @@ -260,6 +262,8 @@ SCM/ po:noun SCSS/ po:noun SDK/S po:noun semver/ po:noun +Sensu/ po:noun +Sensu Go/ po:noun SEO/ po:noun serverless/ po:adjective SHA-1/ po:noun @@ -298,6 +302,7 @@ TCP/ po:noun templated/ po:adjective Tempo/ po:noun Thanos/ po:noun +Threema/ po:noun TLS/ po:noun toolset/S po:noun tooltip/S po:noun @@ -331,6 +336,7 @@ walkthrough/S po:noun web/ po:noun Webpack/ po:noun webserver/S po:noun +Webex/ po:noun Wi-Fi/ po:noun WildFly/ po:noun windows_exporter/S po:noun diff --git a/vale/dictionary/o.jsonnet b/vale/dictionary/o.jsonnet index d7eeb86b2..3128fc589 100644 --- a/vale/dictionary/o.jsonnet +++ b/vale/dictionary/o.jsonnet @@ -9,6 +9,7 @@ local word = import './word.jsonnet'; word.new('OpenShift', '', 'noun') { product: true, swaps: { '(?:[Oo]penshift|openShift)': 'OpenShift' } }, word.new('OpenTelemetry', '', 'adjective'), word.new('OpenTelemetry', '', 'noun') { product: true, swaps: { '(?:[oO]pentelemetry|openTelemetry)': 'OpenTelemetry' } }, + word.new('Opsgenie', '', 'noun') { description: 'https://www.atlassian.com/software/opsgenie', product: true }, word.new('OSS', '', 'noun') { abbreviation: true, elaboration: 'open source software', established_abbreviation: true }, word.new('OTel', '', 'adjective'), word.new('OTel', '', 'noun') { product: true, swaps: { otel: 'OTel' } }, diff --git a/vale/dictionary/p.jsonnet b/vale/dictionary/p.jsonnet index 83bfd5ca3..70a7e70e3 100644 --- a/vale/dictionary/p.jsonnet +++ b/vale/dictionary/p.jsonnet @@ -1,5 +1,6 @@ local word = import './word.jsonnet'; [ + word.new('PagerDuty', '', 'noun') { description: 'https://www.pagerduty.com/', product: true, swaps: { 'pager[dD]uty': 'PagerDuty', Pagerduty: 'PagerDuty' } }, word.new('Parca', '', 'noun') { product: true }, word.new('path', 'S', 'noun') { description: 'A string that represents a file or directory location in a filesystem.', swaps: { '(?:file ?path|path ?name)': 'path', '(?:file ?path|path ?name)s': 'paths' } }, word.new('PDF', 'S', 'noun') { abbreviation: true, elaboration: 'Portable Document Format', established_abbreviation: true }, diff --git a/vale/dictionary/s.jsonnet b/vale/dictionary/s.jsonnet index 833a550ec..ca38345f9 100644 --- a/vale/dictionary/s.jsonnet +++ b/vale/dictionary/s.jsonnet @@ -6,6 +6,8 @@ local word = import './word.jsonnet'; word.new('SCSS', '', 'noun') { abbreviation: true, elaboration: 'Sassy CSS', established_abbreviation: true }, word.new('SDK', 'S', 'noun') { abbreviation: true, elaboration: 'software development kit', established_abbreviation: true }, word.new('semver', '', 'noun') { description: 'Semantic Versioning Specification' }, + word.new('Sensu', '', 'noun') { description: 'https://docs.sensu.io/', product: true, swaps: { sensu: 'Sensu' } }, + word.new('Sensu Go', '', 'noun') { description: 'https://docs.sensu.io/sensu-go/latest/', product: true }, word.new('SEO', '', 'noun') { abbreviation: true, elaboration: 'search engine optimization', established_abbreviation: true }, word.new('serverless', '', 'adjective'), word.new('SHA-1', '', 'noun') { abbreviation: true, elaboration: 'Secure Hash Algorithm 1', established_abbreviation: true, swaps: { '(?:SHA-1|HAS-SHA1)': 'SHA-1' } }, diff --git a/vale/dictionary/t.jsonnet b/vale/dictionary/t.jsonnet index 6a1161b78..6a43bdc0c 100644 --- a/vale/dictionary/t.jsonnet +++ b/vale/dictionary/t.jsonnet @@ -4,6 +4,7 @@ local word = import './word.jsonnet'; word.new('templated', '', 'adjective'), word.new('Tempo', '', 'noun') { product: true, swaps: { tempo: 'Tempo' } }, word.new('Thanos', '', 'noun') { product: true }, + word.new('Threema', '', 'noun') { description: 'https://threema.ch/en', product: true, swaps: { threema: 'Threema' } }, word.new('TLS', '', 'noun') { abbreviation: true, description: 'A cryptographic protocol designed to provide secure communications over network.', elaboration: 'Transport Layer Security', established_abbreviation: true }, word.new('toolset', 'S', 'noun'), word.new('tooltip', 'S', 'noun'), diff --git a/vale/dictionary/w.jsonnet b/vale/dictionary/w.jsonnet index 6a504b36a..173600902 100644 --- a/vale/dictionary/w.jsonnet +++ b/vale/dictionary/w.jsonnet @@ -5,6 +5,7 @@ local word = import './word.jsonnet'; word.new('web', '', 'noun') { swaps: { '[Ww]orld [Ww]ide [Ww]eb': 'web' } }, word.new('Webpack', '', 'noun'), word.new('webserver', 'S', 'noun'), + word.new('Webex', '', 'noun') { description: 'https://www.webex.com/', product: true, swaps: { webex: 'Webex' } }, word.new('Wi-Fi', '', 'noun') { description: 'wireless fidelity', swaps: { '(?:WiFi|wifi)': 'Wi-Fi' } }, word.new('WildFly', '', 'noun') { description: 'WildFly, formerly known as JBoss AS, or simply JBoss, is an application server written by JBoss, now developed by Red Hat (https://en.wikipedia.org/wiki/WildFly)', product: true }, word.new('windows_exporter', 'S', 'noun') { description: 'The Prometheus exporter for Windows machines (https://github.com/prometheus-community/windows_exporter)', product: true },