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

Update v.jsonnet for VM and VMware #848

Merged
merged 2 commits into from
Sep 19, 2024
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
6 changes: 5 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: "2024-09-17"
review_date: "2024-09-19"
title: Vale rules
---

Expand Down Expand Up @@ -809,6 +809,7 @@ _`<CURRENT TEXT>`_ 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`
Expand Down Expand Up @@ -985,6 +986,8 @@ Use _`<REPLACEMENT TEXT>`_ instead of _`<CURRENT TEXT>`_.
| `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` |
Expand Down Expand Up @@ -1053,6 +1056,7 @@ Use _`<REPLACEMENT TEXT>`_ instead of _`<CURRENT TEXT>`_.
| `un(?:check\|select)` | `clear` |
| `url` | `URL` |
| `urls` | `URLs` |
| `vmware` | `VMware` |
| `vs\.` | `versus` |
| `whitelist` | `allowlist` |
| `whitelisted` | `allowlisted` |
Expand Down
1 change: 1 addition & 0 deletions vale/Grafana/Headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
- "Thanos"
- "Velero"
- "Vite"
- "VMware"
- "WildFly"
- "windows_exporter"
- "Zipkin"
Expand Down
1 change: 1 addition & 0 deletions vale/Grafana/ProductPossessives.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
- "Thanos'"
- "Velero's"
- "Vite's"
- "VMware's"
- "WildFly's"
- "windows_exporter's"
- "Zipkin's"
3 changes: 3 additions & 0 deletions vale/Grafana/WordList.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -94,6 +96,7 @@
"un(?:check|select)": "clear"
"url": "URL"
"urls": "URLs"
"vmware": "VMware"
"vs\\.": "versus"
"whitelist": "allowlist"
"whitelisted": "allowlisted"
Expand Down
4 changes: 3 additions & 1 deletion vale/dictionaries/en_US-grafana.dic
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
297
299
ACL/S po:noun
AI Observability/ po:noun
Adaptive Metrics/ po:noun
Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions vale/dictionary/v.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -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, 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' },
Expand Down
2 changes: 1 addition & 1 deletion vale/fixtures/Grafana/Admin/testinvalid.golden
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 2 additions & 2 deletions vale/fixtures/Grafana/Agentless/testinvalid.golden
Original file line number Diff line number Diff line change
@@ -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/).
4 changes: 2 additions & 2 deletions vale/fixtures/Grafana/DropDown/testinvalid.golden
Original file line number Diff line number Diff line change
@@ -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_.
2 changes: 1 addition & 1 deletion vale/fixtures/Grafana/Quickstart/testinvalid.golden
Original file line number Diff line number Diff line change
@@ -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_.
10 changes: 5 additions & 5 deletions vale/fixtures/Grafana/Shortcodes/testinvalid.golden
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
testinvalid.md:3:3:Grafana.Shortcodes:Prefer `{{< admonition type="<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="<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="<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="<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="<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.