Add Frontend Observability to sentence case exceptions (#425)

grafana · Jan 25, 2024 · 39b33f7 · 39b33f7
1 parent 9b58ab2
commit 39b33f7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/vale/Grafana/Headings.yml b/vale/Grafana/Headings.yml
@@ -18,6 +18,7 @@ exceptions:
   - Cloud Traces
   - Cluster # Kubernetes
   - CPU
+  - Frontend Observability
   - Grafana
   - Grafana Cloud
   - Grafana Cloud Traces

diff --git a/vale/Grafana/Spelling.yml b/vale/Grafana/Spelling.yml
@@ -1,5 +1,12 @@
 extends: spelling
-message: "Did you really mean '%s'?"
+message: |
+  Did you really mean '%s'?
+
+  For UI elements, use [bold formatting](https://grafana.com/docs/writers-toolkit/write/style-guide/style-conventions/#bold).
+  The spell checker doesn't check words with bold formatting.
+
+  For paths; configuration; user input; code; class, method, and variable names; statuscodes; and console output, use [code formatting](https://grafana.com/docs/writers-toolkit/write/style-guide/style-conventions/#bold).
+  The spell checker doesn't check words with code formatting.
 level: error
 append: true
 dicpath: dictionaries