Update abbreviation rules so that elaborations are in heading excepti…

…ons and add web-vital product headings (#747)

Co-authored-by: Jack Baldry <[email protected]>

vale/Grafana/AmazonProductNames.yml

@@ -1,6 +1,6 @@
 "extends": "conditional"
-"first": "\b(CloudWatch|Data Firehose|Relational Database Service)\b"
+"first": "\b(CloudWatch|Data Firehose|Firehose|Kinesis|Relational Database Service)\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."
-"second": "Amazon (CloudWatch|Data Firehose|Relational Database Service)"
+"second": "Amazon (CloudWatch|Data Firehose|Firehose|Kinesis|Relational Database Service)"

vale/Grafana/Headings.yml

@@ -1,26 +1,52 @@
 "exceptions":
   - "Amazon CloudWatch"
   - "Amazon Data Firehose"
+  - "Amazon Firehose"
+  - "Amazon Kinesis"
   - "Amazon Relational Database Service"
   - "Agent"
   - "Alloy"
+  - "AWS"
   - "Beyla"
   - "CloudWatch"
   - "Codespaces"
   - "Data Firehose"
+  - "Databricks"
+  - "Datadog"
+  - "Dynatrace"
+  - "Firehose"
+  - "GNU"
   - "Grafana"
+  - "Gravatar"
+  - "Graylog"
+  - "Jaeger"
+  - "Jira"
+  - "Kibana"
   - "Killercoda"
+  - "Kinesis"
   - "Loki"
   - "Mimir"
+  - "Moodle"
+  - "Okta"
+  - "OnCall"
+  - "OpenTelemetry"
+  - "OTel"
+  - "Parca"
   - "Phlare"
+  - "Podman"
+  - "Promtail"
   - "Pyroscope"
   - "RDS"
   - "Relational Database Service"
+  - "React"
   - "Rollup"
+  - "Splunk"
   - "Tempo"
+  - "Thanos"
   - "Velero"
   - "Vite"
   - "windows_exporter"
+  - "Zipkin"
   - "ACL"
   - "API"
   - "APT"
@@ -30,12 +56,16 @@
   - "CLA"
   - "CLI"
   - "CORS"
+  - "CLS"
   - "CPU"
+  - "CRD"
   - "CSS"
   - "CSV"
   - "DOM"
   - "eBPF"
   - "FAQ"
+  - "FCP"
+  - "FID"
   - "GNU"
   - "GPU"
   - "GUI"
@@ -47,12 +77,16 @@
   - "JPG"
   - "JSON"
   - "JSX"
+  - "KEDA"
+  - "KPI"
+  - "LCP"
   - "LESS"
   - "OSS"
   - "OTLP"
   - "PDF"
   - "PHP"
   - "PNG"
+  - "PVC"
   - "RAM"
   - "RDS"
   - "REPL"
@@ -76,6 +110,7 @@
   - "TCP"
   - "TLS"
   - "TSDB"
+  - "TTL"
   - "UI"
   - "UX"
   - "URI"
@@ -90,6 +125,48 @@
   - "XSS"
   - "YAML"
   - "ZIP"
+  - "Application Programming Interface"
+  - "Advanced package tool"
+  - "Amazon Web Services"
+  - "Berkeley Packet Filter"
+  - "Content Delivery Network"
+  - "Contributor License Agreement"
+  - "Cumulative Layout Shift"
+  - "Custom Resource Definition"
+  - "Cascading Style Sheets"
+  - "Comma-separated values"
+  - "Document Object Model"
+  - "First Contentful Paint"
+  - "First Input Delay"
+  - "HyperText Markup Language"
+  - "HyperText Transfer Protocol"
+  - "HyperText Transfer Protocol Secure"
+  - "Kubernetes-based Event-Driven Autoscaling"
+  - "Largest Contentful Paint"
+  - "Leaner Style Sheets"
+  - "OpenTelemetry Protocol"
+  - "Portable Document Format"
+  - "PHP: Hypertext Preprocessor"
+  - "Portable Network Graphics"
+  - "Persistent Volume Claim"
+  - "Relational Database Service"
+  - "RPM Package Manager"
+  - "Rivest–Shamir–Adleman"
+  - "Sassy CSS"
+  - "Structured Query Language"
+  - "Secure Shell"
+  - "Secure Sockets Layer"
+  - "System Under Test"
+  - "Scalable Vector Graphics"
+  - "Transmission Control Protocol"
+  - "Transport Layer Security"
+  - "Uniform Resource Identifier"
+  - "Uniform Resource Locator"
+  - "Universal Serial Bus"
+  - "Coordinated Universal Time"
+  - "Unicode Transformation Format"
+  - "Extensible Markup Language"
+  - "YAML Ain't Markup Language"
   - "Adaptive Metrics"
   - "Ansible"
   - "Application Observability"

vale/Grafana/ProductPossessives.yml

@@ -9,37 +9,85 @@
   - "Agent’s"
   - "Alloy's"
   - "Alloy’s"
+  - "AWS's"
+  - "AWS’s"
   - "Beyla's"
   - "Beyla’s"
   - "CloudWatch's"
   - "CloudWatch’s"
-  - "Codespaces's"
-  - "Codespaces’s"
+  - "Codespaces'"
+  - "Codespaces’"
   - "Data Firehose's"
   - "Data Firehose’s"
+  - "Databricks'"
+  - "Databricks’"
+  - "Datadog's"
+  - "Datadog’s"
+  - "Dynatrace's"
+  - "Dynatrace’s"
+  - "Firehose's"
+  - "Firehose’s"
+  - "GNU's"
+  - "GNU’s"
   - "Grafana's"
   - "Grafana’s"
+  - "Gravatar's"
+  - "Gravatar’s"
+  - "Graylog's"
+  - "Graylog’s"
+  - "Jaeger's"
+  - "Jaeger’s"
+  - "Jira's"
+  - "Jira’s"
+  - "Kibana's"
+  - "Kibana’s"
   - "Killercoda's"
   - "Killercoda’s"
+  - "Kinesis'"
+  - "Kinesis’"
   - "Loki's"
   - "Loki’s"
   - "Mimir's"
   - "Mimir’s"
+  - "Moodle's"
+  - "Moodle’s"
+  - "Okta's"
+  - "Okta’s"
+  - "OnCall's"
+  - "OnCall’s"
+  - "OpenTelemetry's"
+  - "OpenTelemetry’s"
+  - "OTel's"
+  - "OTel’s"
+  - "Parca's"
+  - "Parca’s"
   - "Phlare's"
   - "Phlare’s"
+  - "Podman's"
+  - "Podman’s"
+  - "Promtail's"
+  - "Promtail’s"
   - "Pyroscope's"
   - "Pyroscope’s"
   - "RDS's"
   - "RDS’s"
   - "Relational Database Service's"
   - "Relational Database Service’s"
+  - "React's"
+  - "React’s"
   - "Rollup's"
   - "Rollup’s"
+  - "Splunk's"
+  - "Splunk’s"
   - "Tempo's"
   - "Tempo’s"
+  - "Thanos'"
+  - "Thanos’"
   - "Velero's"
   - "Velero’s"
   - "Vite's"
   - "Vite’s"
   - "windows_exporter's"
   - "windows_exporter’s"
+  - "Zipkin's"
+  - "Zipkin’s"

vale/Headings.jsonnet

@@ -23,6 +23,11 @@ std.manifestYamlDoc({
       for def in defs
       if 'abbreviation' in def && def.abbreviation
     ] +
+    [
+      def.elaboration
+      for def in defs
+      if ('abbreviation' in def && def.abbreviation) && ('elaboration' in def && std.any(std.map(function(c) local cp = std.codepoint(c); cp >= 65 && cp < 97, std.stringChars(def.elaboration))))
+    ] +
     [
       'Adaptive Metrics',
       'Ansible',

vale/ProductPossessives.jsonnet

@@ -8,7 +8,9 @@ std.manifestYamlDoc({
     Instead, use the name as a modifier or rewrite to use a word like of to indicate the relationship.
   |||,
   tokens: std.flattenArrays([
-    ["%s's" % def.word, '%s’s' % def.word]
+    (if def.word[std.length(def.word) - 1] == 's'
+     then [def.word + "'", def.word + '’']
+     else [def.word + "'s", def.word + '’s'])
     for def in defs
     if 'product' in def && def.product
   ]),