From c02c0cb8183a260da3531f6df773069e42b51da8 Mon Sep 17 00:00:00 2001 From: melGL <81323402+melgl@users.noreply.github.com> Date: Wed, 18 Sep 2024 17:59:49 -0500 Subject: [PATCH 1/2] Update v.jsonnet for VM and VMware Added entries for VM and VMware. --- vale/dictionary/v.jsonnet | 2 ++ 1 file changed, 2 insertions(+) diff --git a/vale/dictionary/v.jsonnet b/vale/dictionary/v.jsonnet index c310759d9..c25139c53 100644 --- a/vale/dictionary/v.jsonnet +++ b/vale/dictionary/v.jsonnet @@ -4,6 +4,8 @@ local word = import './word.jsonnet'; word.new('versus', '', 'preposition') { description: 'against (https://en.wiktionary.org/wiki/versus)', swaps: { 'vs\\.': 'versus' } }, word.new('viewport', 'S', 'noun') { description: 'A viewport is a polygon viewing region in computer graphics (https://en.wikipedia.org/wiki/Viewport)' }, word.new('Vite', '', 'noun') { description: 'Next Generation Frontend Tooling (https://vitejs.dev/)', product: true }, + word.new('VM', 'S', 'noun') { description: 'Virtual Machine'}, + word.new('VMware', '', 'noun') { description: 'VMware LLC is an American cloud computing and virtualization technology company.', product: true }, word.new('VPC', 'S', 'noun') { abbreviation: true, elaboration: 'virtual private cloud', established_abbreviation: true }, word.new('VU', 'S', 'noun') { abbreviation: true, elaboration: 'virtual user' }, word.new('VUH', 'S', 'noun') { abbreviation: true, elaboration: 'virtual user hour' }, From 88368ce49dae5338c5dc63bf2f44c90bdc373458 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Thu, 19 Sep 2024 09:00:11 +0100 Subject: [PATCH 2/2] Update dictionary and fixtures Signed-off-by: Jack Baldry --- docs/sources/review/lint-prose/rules.md | 6 +++++- vale/Grafana/Headings.yml | 1 + vale/Grafana/ProductPossessives.yml | 1 + vale/Grafana/WordList.yml | 3 +++ vale/dictionaries/en_US-grafana.dic | 4 +++- vale/dictionary/v.jsonnet | 4 ++-- vale/fixtures/Grafana/Admin/testinvalid.golden | 2 +- vale/fixtures/Grafana/Agentless/testinvalid.golden | 4 ++-- vale/fixtures/Grafana/DropDown/testinvalid.golden | 4 ++-- vale/fixtures/Grafana/Quickstart/testinvalid.golden | 2 +- vale/fixtures/Grafana/Shortcodes/testinvalid.golden | 10 +++++----- 11 files changed, 26 insertions(+), 15 deletions(-) diff --git a/docs/sources/review/lint-prose/rules.md b/docs/sources/review/lint-prose/rules.md index 2a796f3f9..c92676c35 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: "2024-09-17" +review_date: "2024-09-19" title: Vale rules --- @@ -809,6 +809,7 @@ _``_ was matched by one or more of the following regular expressio - `Thanos'` - `Velero's` - `Vite's` +- `VMware's` - `WildFly's` - `windows_exporter's` - `Zipkin's` @@ -985,6 +986,8 @@ Use _``_ instead of _``_. | `Grafana AI observability` | `Grafana AI Observability` | | `HTTPs` | `HTTPS` | | `Once` | `After` | +| `VMWare` | `VMware` | +| `Vmware` | `VMware` | | `[Ww]orld [Ww]ide [Ww]eb` | `web` | | `[cC]entos` | `CentOS` | | `\b(?:[aA]daptive metrics\|adaptive Metrics)\b` | `Adaptive Metrics` | @@ -1053,6 +1056,7 @@ Use _``_ instead of _``_. | `un(?:check\|select)` | `clear` | | `url` | `URL` | | `urls` | `URLs` | +| `vmware` | `VMware` | | `vs\.` | `versus` | | `whitelist` | `allowlist` | | `whitelisted` | `allowlisted` | diff --git a/vale/Grafana/Headings.yml b/vale/Grafana/Headings.yml index 23810cc2d..849a4c209 100644 --- a/vale/Grafana/Headings.yml +++ b/vale/Grafana/Headings.yml @@ -71,6 +71,7 @@ - "Thanos" - "Velero" - "Vite" + - "VMware" - "WildFly" - "windows_exporter" - "Zipkin" diff --git a/vale/Grafana/ProductPossessives.yml b/vale/Grafana/ProductPossessives.yml index adc65a1d4..edcd69204 100644 --- a/vale/Grafana/ProductPossessives.yml +++ b/vale/Grafana/ProductPossessives.yml @@ -71,6 +71,7 @@ - "Thanos'" - "Velero's" - "Vite's" + - "VMware's" - "WildFly's" - "windows_exporter's" - "Zipkin's" diff --git a/vale/Grafana/WordList.yml b/vale/Grafana/WordList.yml index 7eb599d51..822bae421 100644 --- a/vale/Grafana/WordList.yml +++ b/vale/Grafana/WordList.yml @@ -26,6 +26,8 @@ "Grafana AI observability": "Grafana AI Observability" "HTTPs": "HTTPS" "Once": "After" + "VMWare": "VMware" + "Vmware": "VMware" "[Ww]orld [Ww]ide [Ww]eb": "web" "[cC]entos": "CentOS" "\\b(?:[aA]daptive metrics|adaptive Metrics)\\b": "Adaptive Metrics" @@ -94,6 +96,7 @@ "un(?:check|select)": "clear" "url": "URL" "urls": "URLs" + "vmware": "VMware" "vs\\.": "versus" "whitelist": "allowlist" "whitelisted": "allowlisted" diff --git a/vale/dictionaries/en_US-grafana.dic b/vale/dictionaries/en_US-grafana.dic index be8ae411f..0853273e8 100644 --- a/vale/dictionaries/en_US-grafana.dic +++ b/vale/dictionaries/en_US-grafana.dic @@ -1,4 +1,4 @@ -297 +299 ACL/S po:noun AI Observability/ po:noun Adaptive Metrics/ po:noun @@ -277,6 +277,8 @@ Velero/ po:noun versus/ po:preposition viewport/S po:noun Vite/ po:noun +VM/S po:noun +VMware/ po:noun VPC/S po:noun VU/S po:noun VUH/S po:noun diff --git a/vale/dictionary/v.jsonnet b/vale/dictionary/v.jsonnet index c25139c53..0cdf87bcd 100644 --- a/vale/dictionary/v.jsonnet +++ b/vale/dictionary/v.jsonnet @@ -4,8 +4,8 @@ local word = import './word.jsonnet'; word.new('versus', '', 'preposition') { description: 'against (https://en.wiktionary.org/wiki/versus)', swaps: { 'vs\\.': 'versus' } }, word.new('viewport', 'S', 'noun') { description: 'A viewport is a polygon viewing region in computer graphics (https://en.wikipedia.org/wiki/Viewport)' }, word.new('Vite', '', 'noun') { description: 'Next Generation Frontend Tooling (https://vitejs.dev/)', product: true }, - word.new('VM', 'S', 'noun') { description: 'Virtual Machine'}, - word.new('VMware', '', 'noun') { description: 'VMware LLC is an American cloud computing and virtualization technology company.', product: true }, + word.new('VM', 'S', 'noun') { description: 'Virtual Machine' }, + word.new('VMware', '', 'noun') { description: 'VMware LLC is an American cloud computing and virtualization technology company.', product: true, swaps: { vmware: 'VMware', Vmware: 'VMware', VMWare: 'VMware' } }, word.new('VPC', 'S', 'noun') { abbreviation: true, elaboration: 'virtual private cloud', established_abbreviation: true }, word.new('VU', 'S', 'noun') { abbreviation: true, elaboration: 'virtual user' }, word.new('VUH', 'S', 'noun') { abbreviation: true, elaboration: 'virtual user hour' }, diff --git a/vale/fixtures/Grafana/Admin/testinvalid.golden b/vale/fixtures/Grafana/Admin/testinvalid.golden index eb4ae29b7..120b6fae7 100644 --- a/vale/fixtures/Grafana/Admin/testinvalid.golden +++ b/vale/fixtures/Grafana/Admin/testinvalid.golden @@ -1 +1 @@ -testinvalid.md:3:3:Grafana.Admin:Use administrator instead of admin unless it's the name of the UI label like in the Grafana 'Admin' role. +testinvalid.md:3:3:Grafana.Admin:Use 'administrator' instead of 'admin' unless it's the name of the UI label like in the Grafana 'Admin' role. diff --git a/vale/fixtures/Grafana/Agentless/testinvalid.golden b/vale/fixtures/Grafana/Agentless/testinvalid.golden index 484c1bf49..ba8e8d032 100644 --- a/vale/fixtures/Grafana/Agentless/testinvalid.golden +++ b/vale/fixtures/Grafana/Agentless/testinvalid.golden @@ -1,2 +1,2 @@ -testinvalid.md:3:3:Grafana.Agentless:Grafana Agent has been replaced by Grafana Alloy, so you shouldn't use agent-based terminology. If you're talking about why and how to send signals directly from an application to Grafana Cloud, prefer no-collector to agentless. This is consistent with [OTel documentation](https://opentelemetry.io/docs/collector/deployment/no-collector/). -testinvalid.md:4:3:Grafana.Agentless:Grafana Agent has been replaced by Grafana Alloy, so you shouldn't use agent-based terminology. If you're talking about why and how to send signals directly from an application to Grafana Cloud, prefer no-collector to agentless. This is consistent with [OTel documentation](https://opentelemetry.io/docs/collector/deployment/no-collector/). +testinvalid.md:3:3:Grafana.Agentless:Use 'no-collector' instead of 'agentless'. Grafana Agent has been replaced by Grafana Alloy, so you shouldn't use agent-based terminology. If you're talking about why and how to send signals directly from an application to Grafana Cloud, prefer no-collector to agentless. This is consistent with [OTel documentation](https://opentelemetry.io/docs/collector/deployment/no-collector/). +testinvalid.md:4:3:Grafana.Agentless:Use 'no-collector' instead of 'agentless'. Grafana Agent has been replaced by Grafana Alloy, so you shouldn't use agent-based terminology. If you're talking about why and how to send signals directly from an application to Grafana Cloud, prefer no-collector to agentless. This is consistent with [OTel documentation](https://opentelemetry.io/docs/collector/deployment/no-collector/). diff --git a/vale/fixtures/Grafana/DropDown/testinvalid.golden b/vale/fixtures/Grafana/DropDown/testinvalid.golden index 6c8e49ccc..c4c2ebca1 100644 --- a/vale/fixtures/Grafana/DropDown/testinvalid.golden +++ b/vale/fixtures/Grafana/DropDown/testinvalid.golden @@ -1,2 +1,2 @@ -testinvalid.md:3:3:Grafana.DropDown:Use _drop-down_ rather than _dropdown_ or _drop down_. Use drop-down as a modifier rather than as a standalone noun. For example: _drop-down menu_. -testinvalid.md:4:3:Grafana.DropDown:Use _drop-down_ rather than _dropdown_ or _drop down_. Use drop-down as a modifier rather than as a standalone noun. For example: _drop-down menu_. +testinvalid.md:3:3:Grafana.DropDown:Use 'drop-down' instead of 'dropdown'. Use drop-down as a modifier rather than as a standalone noun. For example: _drop-down menu_. +testinvalid.md:4:3:Grafana.DropDown:Use 'drop-down' instead of 'drop down'. Use drop-down as a modifier rather than as a standalone noun. For example: _drop-down menu_. diff --git a/vale/fixtures/Grafana/Quickstart/testinvalid.golden b/vale/fixtures/Grafana/Quickstart/testinvalid.golden index 7bea951f8..d52b21c85 100644 --- a/vale/fixtures/Grafana/Quickstart/testinvalid.golden +++ b/vale/fixtures/Grafana/Quickstart/testinvalid.golden @@ -1 +1 @@ -testinvalid.md:3:3:Grafana.Quickstart:Use the compound adjective without a hyphen whether the noun is implied or explicit. For example, you can use _quickstart guide_ or just _quickstart_. +testinvalid.md:3:3:Grafana.Quickstart:Use the compound adjective 'quickstart' without a hyphen instead of 'quick start' whether the noun is implied or explicit. For example, you can use _quickstart guide_ or just _quickstart_. diff --git a/vale/fixtures/Grafana/Shortcodes/testinvalid.golden b/vale/fixtures/Grafana/Shortcodes/testinvalid.golden index b602f6cae..a0a09eecd 100644 --- a/vale/fixtures/Grafana/Shortcodes/testinvalid.golden +++ b/vale/fixtures/Grafana/Shortcodes/testinvalid.golden @@ -1,5 +1,5 @@ -testinvalid.md:3:3:Grafana.Shortcodes:Prefer `{{< admonition type="" >}}`. It has the most consistent semantics. The percent syntax is used for special behavior that isn't required with this shortcode. -testinvalid.md:4:3:Grafana.Shortcodes:Prefer `{{< admonition type="" >}}`. It has the most consistent semantics. The percent syntax is used for special behavior that isn't required with this shortcode. -testinvalid.md:5:3:Grafana.Shortcodes:Prefer `{{< admonition type="" >}}`. It has the most consistent semantics. The percent syntax is used for special behavior that isn't required with this shortcode. -testinvalid.md:6:3:Grafana.Shortcodes:Prefer `{{< admonition type="" >}}`. It has the most consistent semantics. The percent syntax is used for special behavior that isn't required with this shortcode. -testinvalid.md:7:3:Grafana.Shortcodes:Prefer `{{< admonition type="" >}}`. It has the most consistent semantics. The percent syntax is used for special behavior that isn't required with this shortcode. +testinvalid.md:3:3:Grafana.Shortcodes:Prefer `{{<` and `>}}` instead of `{{%!`(string={{% admonition type="caution" %}}) and `%!}(string=)}` It has the most consistent semantics. The percent syntax is used for special behavior that isn't required with this shortcode. +testinvalid.md:4:3:Grafana.Shortcodes:Prefer `{{<` and `>}}` instead of `{{%!`(string={{% admonition type="note" %}}) and `%!}(string=)}` It has the most consistent semantics. The percent syntax is used for special behavior that isn't required with this shortcode. +testinvalid.md:5:3:Grafana.Shortcodes:Prefer `{{<` and `>}}` instead of `{{%!`(string={{% admonition type="tip" %}}) and `%!}(string=)}` It has the most consistent semantics. The percent syntax is used for special behavior that isn't required with this shortcode. +testinvalid.md:6:3:Grafana.Shortcodes:Prefer `{{<` and `>}}` instead of `{{%!`(string={{% admonition type="warn" %}}) and `%!}(string=)}` It has the most consistent semantics. The percent syntax is used for special behavior that isn't required with this shortcode. +testinvalid.md:7:3:Grafana.Shortcodes:Prefer `{{<` and `>}}` instead of `{{%!`(string={{% /admonition %}}) and `%!}(string=)}` It has the most consistent semantics. The percent syntax is used for special behavior that isn't required with this shortcode.