Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Opsgenie, Sensu, and Threema products to the dictionary #1045

Merged
merged 2 commits into from
Feb 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion docs/sources/review/lint-prose/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

Expand Down Expand Up @@ -827,7 +827,9 @@ _`<CURRENT TEXT>`_ 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`
Expand All @@ -846,14 +848,18 @@ _`<CURRENT TEXT>`_ 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`
Expand Down Expand Up @@ -1014,6 +1020,7 @@ Use _`<REPLACEMENT TEXT>`_ instead of _`<CURRENT TEXT>`_.
| `Influx[Dd]b` | `InfluxDB` |
| `Influxd[Bb]` | `InfluxDB` |
| `Once` | `After` |
| `Pagerduty` | `PagerDuty` |
| `RCA Workbench` | `RCA workbench` |
| `Rudderstack` | `RudderStack` |
| `VMWare` | `VMware` |
Expand Down Expand Up @@ -1067,6 +1074,7 @@ Use _`<REPLACEMENT TEXT>`_ instead of _`<CURRENT TEXT>`_.
| `open-source` | `open source` |
| `otel` | `OTel` |
| `otlp` | `OTLP` |
| `pager[dD]uty` | `PagerDuty` |
| `phlare` | `Phlare` |
| `postgres` | `Postgres` |
| `postgresql` | `PostgreSQL` |
Expand All @@ -1078,6 +1086,7 @@ Use _`<REPLACEMENT TEXT>`_ instead of _`<CURRENT TEXT>`_.
| `repos` | `repositories` |
| `right[- ]hand[- ]side` | `right-side` |
| `rudderstack` | `RudderStack` |
| `sensu` | `Sensu` |
| `sign into` | `sign in to` |
| `sqlite` | `SQLite` |
| `style sheet` | `stylesheet` |
Expand All @@ -1088,13 +1097,15 @@ Use _`<REPLACEMENT TEXT>`_ instead of _`<CURRENT TEXT>`_.
| `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` |
| `url` | `URL` |
| `urls` | `URLs` |
| `vmware` | `VMware` |
| `vs\.` | `versus` |
| `webex` | `Webex` |
| `whitelist` | `allowlist` |
| `whitelisted` | `allowlisted` |
| `whitelisting` | `allowlisting` |
Expand Down
6 changes: 6 additions & 0 deletions vale/Grafana/styles/Grafana/Headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,9 @@
- "OpenAI"
- "OpenShift"
- "OpenTelemetry"
- "Opsgenie"
- "OTel"
- "PagerDuty"
- "Parca"
- "Phlare"
- "Pinecone"
Expand All @@ -90,14 +92,18 @@
- "RHEL"
- "Rollup"
- "RudderStack"
- "Sensu"
- "Sensu Go"
- "Splunk"
- "SSM"
- "SUSE"
- "Tempo"
- "Thanos"
- "Threema"
- "Velero"
- "Vite"
- "VMware"
- "Webex"
- "WildFly"
- "windows_exporter"
- "Zipkin"
Expand Down
6 changes: 6 additions & 0 deletions vale/Grafana/styles/Grafana/ProductPossessives.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@
- "OpenAI's"
- "OpenShift's"
- "OpenTelemetry's"
- "Opsgenie's"
- "OTel's"
- "PagerDuty's"
- "Parca's"
- "Phlare's"
- "Pinecone's"
Expand All @@ -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"
5 changes: 5 additions & 0 deletions vale/Grafana/styles/Grafana/WordList.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"Influx[Dd]b": "InfluxDB"
"Influxd[Bb]": "InfluxDB"
"Once": "After"
"Pagerduty": "PagerDuty"
"RCA Workbench": "RCA workbench"
"Rudderstack": "RudderStack"
"VMWare": "VMware"
Expand Down Expand Up @@ -83,6 +84,7 @@
"open-source": "open source"
"otel": "OTel"
"otlp": "OTLP"
"pager[dD]uty": "PagerDuty"
"phlare": "Phlare"
"postgres": "Postgres"
"postgresql": "PostgreSQL"
Expand All @@ -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"
Expand All @@ -104,13 +107,15 @@
"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"
"url": "URL"
"urls": "URLs"
"vmware": "VMware"
"vs\\.": "versus"
"webex": "Webex"
"whitelist": "allowlist"
"whitelisted": "allowlisted"
"whitelisting": "allowlisting"
Expand Down
8 changes: 7 additions & 1 deletion vale/Grafana/styles/config/dictionaries/en_US-grafana.dic
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
343
349
ACL/S po:noun
ADOT/ po:noun
AI Observability/ po:noun
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions vale/dictionary/o.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -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' } },
Expand Down
1 change: 1 addition & 0 deletions vale/dictionary/p.jsonnet
Original file line number Diff line number Diff line change
@@ -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 },
Expand Down
2 changes: 2 additions & 0 deletions vale/dictionary/s.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -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' } },
Expand Down
1 change: 1 addition & 0 deletions vale/dictionary/t.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -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'),
Expand Down
1 change: 1 addition & 0 deletions vale/dictionary/w.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -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 },
Expand Down
Loading