diff --git a/.github/workflows/validate-documentation.yml b/.github/workflows/validate-documentation.yml index 7357eb299..e20c09894 100644 --- 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 index f4087ed3f..db7a52f5c 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-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 _``_ 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 @@ _``_ 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 @@ _``_ 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 @@ _``_ 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 _``_ instead of _``_. | `(?: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` | | `(?`_ instead of _``_. | `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 _``_ instead of _``_. | `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 _``_ instead of _``_. | `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 index d98caaf3d..6c1f95405 100644 --- 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 index 01c184bfd..5ac5bdfff 100644 --- 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 index 44bf656ee..66f160d70 100644 --- 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 index 2b1221a06..a9383a977 100644 --- 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 index 0dfa8887a..ec7bb904e 100644 --- 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 index d22f7d18e..7566c0b5a 100644 --- 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" "(? $@ 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 > $@ diff --git a/vale/Grafana/styles/config/dictionaries/en_US-grafana.dic b/vale/Grafana/styles/config/dictionaries/en_US-grafana.dic index 706f91f86..80071a981 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 @@ -321 +332 ACL/S po:noun ADOT/ po:noun AI Observability/ po:noun @@ -43,11 +43,14 @@ checkbox/S po:noun CLA/ po:noun clear/S po:verb CLI/ po:noun +clickjack/DSG po:noun CloudWatch/ po:noun CLS/ po:noun CMS/ po:noun codespace/S po:noun Codespaces/ po:noun +comment/S po:noun +comment/uDG po:verb composable/ po:adjective configure/mpDS po:verb contentful/ po:adjective @@ -80,6 +83,7 @@ Elastic Kubernetes Service/ po:noun email/ po:noun enablement/ po:noun enqueue/DS po:verb +Entra/ po:noun ESLint/M po:noun etcd/ po:noun FAQ/S po:noun @@ -95,6 +99,7 @@ GEM/ po:noun GKE/ po:noun Git/ po:noun GitHub/ po:noun +GitLab/ po:noun glob/G po:noun globbing/ po:verb GNU/ po:noun @@ -109,14 +114,16 @@ Gravatar/ po:noun Graylog/ po:noun GUI/S po:noun Gzip/ po:noun -heatmap/S po:noun +Hashicorp/ po:noun hashmod/ po:noun +heatmap/S po:noun hostname/S po:noun HPA/S po:noun HTML/ po:noun HTTP/ po:noun HTTPS/ po:noun IBM/ po:noun +ICU/ po:noun IDE/S po:noun inclusivity/ po:noun ingester/MS po:noun @@ -124,6 +131,7 @@ Istio/ po:noun Jaeger/ po:adjective Jaeger/ po:noun JAR/ po:noun +JavaScript/ po:noun Jira/ po:noun JMeter/M po:noun journald/ po:noun @@ -152,6 +160,7 @@ Linode/M po:noun LogQL/ po:noun Loki/ po:noun lookup/S po:noun +loopback/ po:noun manage/uD po:verb Markdown/ po:noun marshal/u po:verb @@ -234,6 +243,7 @@ rollout/S po:noun Rollup/ po:noun RPM/ po:noun RSA/ po:noun +RudderStack/ po:noun runbook/S po:noun sandbox/DG po:verb scheduler/MS po:noun @@ -272,6 +282,7 @@ SUSE/ po:noun SUT/ po:noun SVG/ po:noun sync/DG po:verb +syslog/ po:noun systemd/ po:noun TCP/ po:noun Tempo/ po:noun diff --git a/vale/Makefile b/vale/Makefile index 79f5754ac..376a2fa19 100644 --- a/vale/Makefile +++ b/vale/Makefile @@ -25,7 +25,12 @@ $(DOCUMENTATION): $(wildcard Grafana/styles/Grafana/*) $(wildcard ../tools/cmd/g cd ../tools/ && go run ./cmd/generate-documentation ../ tools/cmd/generate-documentation vale/Grafana/styles/Grafana docs/sources/review/lint-prose/rules.md prettier -w $(DOCUMENTATION) -Grafana/styles/config/dictionaries/en_US-grafana.%: dictionary.libsonnet + +.PHONY: dictionaries +dictionaries: ## Build the Grafana Vale dictionary files. +dictionaries: $(DICTIONARIES) + +Grafana/styles/config/dictionaries/en_US-grafana.%: dictionary.libsonnet $(wildcard dictionary/*.jsonnet) $(MAKE) -C $(@D) $(@F) IMAGE_PREREQUISITES := Grafana/styles/config/dictionaries/en_US-grafana.aff Grafana/styles/config/dictionaries/en_US-grafana.dic Grafana/styles/Grafana/Google .vale.ini diff --git a/vale/dictionary/c.jsonnet b/vale/dictionary/c.jsonnet index c0aec463a..dcaa6b1c7 100644 --- a/vale/dictionary/c.jsonnet +++ b/vale/dictionary/c.jsonnet @@ -8,11 +8,14 @@ local word = import './word.jsonnet'; word.new('CLA', '', 'noun') { abbreviation: true, elaboration: 'Contributor License Agreement' }, word.new('clear', 'S', 'verb') { swaps: { 'un(?:check|select)': 'clear' } }, word.new('CLI', '', 'noun') { abbreviation: true, established_abbreviation: true }, + word.new('clickjack', 'DSG', 'noun') { description: 'A type of attack where a malicious website tricks a user into clicking on a hidden element on another website' }, word.new('CloudWatch', '', 'noun') { Amazon: true, product: true }, word.new('CLS', '', 'noun') { abbreviation: true, elaboration: 'Cumulative Layout Shift' }, word.new('CMS', '', 'noun') { abbreviation: true, elaboration: 'content management system' }, word.new('codespace', 'S', 'noun') { description: "A codespace is a development environment that's hosted in the cloud. https://docs.github.com/en/codespaces/overview" }, word.new('Codespaces', '', 'noun') { description: 'GitHub Codespaces https://docs.github.com/en/codespaces/overview', product: true }, + word.new('comment', 'S', 'noun'), + word.new('comment', 'uDG', 'verb'), word.new('composable', '', 'adjective'), word.new('configure', 'mpDS', 'verb'), word.new('contentful', '', 'adjective') { description: 'Having content. Used in Web Vital metrics, such as Largest Contentful Paint: https://web.dev/articles/lcp' }, diff --git a/vale/dictionary/e.jsonnet b/vale/dictionary/e.jsonnet index a56015841..2ef7bacdf 100644 --- a/vale/dictionary/e.jsonnet +++ b/vale/dictionary/e.jsonnet @@ -3,9 +3,10 @@ local word = import './word.jsonnet'; word.new('eBPF', '', 'noun') { abbreviation: true, established_abbreviation: true }, word.new('EKS', '', 'noun') { abbreviation: true, elaboration: 'Elastic Kubernetes Service', product: true }, word.new('Elastic Kubernetes Service', '', 'noun') { Amazon: true, product: true }, - word.new('email', '', 'noun') { swaps: { '(?:e-mail|Email|E-mail)': 'email' } }, + word.new('email', '', 'noun') { swaps: { '(?:[eE]-mail)': 'email' } }, word.new('enablement', '', 'noun'), word.new('enqueue', 'DS', 'verb'), + word.new('Entra', '', 'noun') { Azure: true, product: true }, word.new('ESLint', 'M', 'noun'), word.new('etcd', '', 'noun'), ] diff --git a/vale/dictionary/g.jsonnet b/vale/dictionary/g.jsonnet index d18c5c291..841813be3 100644 --- a/vale/dictionary/g.jsonnet +++ b/vale/dictionary/g.jsonnet @@ -3,7 +3,8 @@ local word = import './word.jsonnet'; word.new('GEM', '', 'noun') { abbreviation: true, elaboration: 'Grafana Enterprise Metrics', product: true, swaps: { GME: 'GEM' } }, word.new('GKE', '', 'noun') { abbreviation: true, elaboration: 'Google Kubernetes Engine', product: true }, // Doesn't need Google: true because Google is in the name. word.new('Git', '', 'noun') { product: true, swaps: { git: 'Git' } }, - word.new('GitHub', '', 'noun') { product: true, swaps: { '(?:[gG]itHub]|Github)': 'GitHub' } }, + word.new('GitHub', '', 'noun') { product: true, swaps: { '(?:github|gitHub|Github)': 'GitHub' } }, + word.new('GitLab', '', 'noun') { product: true, swaps: { '(?:gitlab|gitLab|Gitlab)': 'GitLab' } }, word.new('glob', 'G', 'noun') { description: 'In computer programming, glob patterns specify sets of filenames with wildcard characters.' }, word.new('globbing', '', 'verb') { description: 'In computer programming, glob patterns specify sets of filenames with wildcard characters.' }, word.new('GNU', '', 'noun') { abbreviation: true, established_abbreviation: true, product: true }, diff --git a/vale/dictionary/h.jsonnet b/vale/dictionary/h.jsonnet index f4e50b3c9..ad2dbe055 100644 --- a/vale/dictionary/h.jsonnet +++ b/vale/dictionary/h.jsonnet @@ -1,10 +1,11 @@ local word = import './word.jsonnet'; [ + word.new('Hashicorp', '', 'noun') { elaboration: 'A company that produces a suite of infrastructure automation products.' }, + word.new('hashmod', '', 'noun') { description: 'A program that distributes an enabled / disabled flag across a cluster without coordination, using consistent hashing.', product: true }, word.new('heatmap', 'S', 'noun'), - word.new('hashmod', '', 'noun') { description:'A program that distributes an enabled / disabled flag across a cluster without coordination, using consistent hashing.', product: true }, word.new('hostname', 'S', 'noun'), word.new('HPA', 'S', 'noun'), word.new('HTML', '', 'noun') { abbreviation: true, elaboration: 'HyperText Markup Language', established_abbreviation: true }, word.new('HTTP', '', 'noun') { abbreviation: true, elaboration: 'HyperText Transfer Protocol', established_abbreviation: true }, word.new('HTTPS', '', 'noun') { abbreviation: true, elaboration: 'HyperText Transfer Protocol Secure', established_abbreviation: true, swaps: { HTTPs: 'HTTPS' } }, - ] +] diff --git a/vale/dictionary/i.jsonnet b/vale/dictionary/i.jsonnet index 473a72d36..679b6ab8e 100644 --- a/vale/dictionary/i.jsonnet +++ b/vale/dictionary/i.jsonnet @@ -1,6 +1,7 @@ local word = import './word.jsonnet'; [ word.new('IBM', '', 'noun') { abbreviation: true, established_abbreviation: true, product: true }, + word.new('ICU', '', 'noun') { abbreviation: true, elaboration: 'International Components for Unicode' }, word.new('IDE', 'S', 'noun') { abbreviation: true, elaboration: 'integrated development environment', established_abbreviation: true }, word.new('inclusivity', '', 'noun'), word.new('ingester', 'MS', 'noun'), diff --git a/vale/dictionary/j.jsonnet b/vale/dictionary/j.jsonnet index a8f4fd131..1c824b0f6 100644 --- a/vale/dictionary/j.jsonnet +++ b/vale/dictionary/j.jsonnet @@ -3,9 +3,10 @@ local word = import './word.jsonnet'; word.new('Jaeger', '', 'adjective'), word.new('Jaeger', '', 'noun') { product: true }, word.new('JAR', '', 'noun') { abbreviation: true, established_abbreviation: true }, + word.new('JavaScript', '', 'noun') { description: 'A high-level, interpreted programming language.', swaps: { '(?:java[Ss]cript|Javascript)': 'JavaScript' } }, word.new('Jira', '', 'noun') { product: true }, word.new('JMeter', 'M', 'noun'), - word.new('journald', '', 'noun') { description:'A system service that collects and stores logging data.', product: true }, + word.new('journald', '', 'noun') { description: 'A system service that collects and stores logging data.', product: true }, word.new('JPG', '', 'noun') { abbreviation: true, established_abbreviation: true }, word.new('JSON', '', 'noun') { abbreviation: true, established_abbreviation: true }, word.new('Jsonnet', '', 'noun') { product: true, swaps: { jsonnet: 'Jsonnet' } }, diff --git a/vale/dictionary/l.jsonnet b/vale/dictionary/l.jsonnet index b1035a89a..a98c40471 100644 --- a/vale/dictionary/l.jsonnet +++ b/vale/dictionary/l.jsonnet @@ -1,7 +1,7 @@ local word = import './word.jsonnet'; [ word.new('LangChain', '', 'noun') { description: 'https://www.langchain.com/', product: true, swaps: { langchain: 'LangChain' } }, - word.new('launchd', '', 'noun') { description:'An open-source service management framework used with macOS.', product: true }, + word.new('launchd', '', 'noun') { description: 'An open-source service management framework used with macOS.', product: true }, word.new('LCP', '', 'noun') { abbreviation: true, elaboration: 'Largest Contentful Paint' }, word.new('LESS', '', 'noun') { abbreviation: true, elaboration: 'Leaner Style Sheets', established_abbreviation: true }, word.new('LLM', 'S', 'noun') { abbreviation: true, elaboration: 'large language model' }, @@ -9,4 +9,5 @@ local word = import './word.jsonnet'; word.new('LogQL', '', 'noun') { description: 'The Grafana Loki log query language.', swaps: { 'log(?:ql|QL)': 'LogQL' } }, word.new('Loki', '', 'noun') { product: true, swaps: { loki: 'Loki' } }, word.new('lookup', 'S', 'noun'), + word.new('loopback', '', 'noun') { description: 'A network interface that is used to send data back to the same device.' }, ] diff --git a/vale/dictionary/o.jsonnet b/vale/dictionary/o.jsonnet index 07d5bb93b..d7eeb86b2 100644 --- a/vale/dictionary/o.jsonnet +++ b/vale/dictionary/o.jsonnet @@ -12,7 +12,7 @@ local word = import './word.jsonnet'; 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' } }, - word.new('OTLP', '', 'noun') { abbreviation: true, elaboration: 'OpenTelemetry Protocol', established_abbreviation: true }, + word.new('OTLP', '', 'noun') { abbreviation: true, elaboration: 'OpenTelemetry Protocol', established_abbreviation: true, swaps: { otlp: 'OTLP' } }, word.new('overbill', 'DG', 'verb'), word.new('overutilization', 'S', 'noun'), ] diff --git a/vale/dictionary/r.jsonnet b/vale/dictionary/r.jsonnet index d5cac9d8d..f42f82320 100644 --- a/vale/dictionary/r.jsonnet +++ b/vale/dictionary/r.jsonnet @@ -21,5 +21,6 @@ local word = import './word.jsonnet'; word.new('Rollup', '', 'noun') { description: 'The JavaScript module bundler (https://rollupjs.org/)', product: true }, word.new('RPM', '', 'noun') { abbreviation: true, description: 'https://en.wikipedia.org/wiki/RPM_Package_Manager', elaboration: 'RPM Package Manager', established_abbreviation: true }, word.new('RSA', '', 'noun') { abbreviation: true, elaboration: 'Rivest–Shamir–Adleman', established_abbreviation: true }, + word.new('RudderStack', '', 'noun') { description: 'https://www.rudderstack.com/', product: true, swaps: { rudderstack: 'RudderStack', Rudderstack: 'RudderStack' } }, word.new('runbook', 'S', 'noun'), ] diff --git a/vale/dictionary/s.jsonnet b/vale/dictionary/s.jsonnet index cb2548f81..cf682ebca 100644 --- a/vale/dictionary/s.jsonnet +++ b/vale/dictionary/s.jsonnet @@ -37,5 +37,6 @@ local word = import './word.jsonnet'; word.new('SUT', '', 'noun') { abbreviation: true, elaboration: 'System Under Test' }, word.new('SVG', '', 'noun') { abbreviation: true, elaboration: 'Scalable Vector Graphics', established_abbreviation: true }, word.new('sync', 'DG', 'verb') { swaps: { synch: 'sync', synched: 'synced', synching: 'syncing' } }, - word.new('systemd', '', 'noun'), + word.new('syslog', '', 'noun') { description: 'A standard for message logging' }, + word.new('systemd', '', 'noun') { description: 'A system and service manager for Linux' }, ] diff --git a/vale/dictionary/word.jsonnet b/vale/dictionary/word.jsonnet index d32413206..baa35f23b 100644 --- a/vale/dictionary/word.jsonnet +++ b/vale/dictionary/word.jsonnet @@ -5,6 +5,7 @@ affixes: [], Amazon: false, Apache: false, + Azure: false, Google: false, description: null, established_abbreviation: false,