From 4b6a1185721112a84a08ffc9efc33bfea309cc4c Mon Sep 17 00:00:00 2001
From: Jack Baldry <jack.baldry@grafana.com>
Date: Tue, 13 Feb 2024 15:37:23 +0000
Subject: [PATCH] Add explanation for resolving product name linting issues
 (#475)

---
 vale/Grafana/Spelling.yml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/vale/Grafana/Spelling.yml b/vale/Grafana/Spelling.yml
index ca4e0dc1e..5741c4eb7 100644
--- a/vale/Grafana/Spelling.yml
+++ b/vale/Grafana/Spelling.yml
@@ -2,6 +2,10 @@ extends: spelling
 message: |
   Did you really mean '%s'?
 
+  For product names, the Grafana dictionary might not know of it yet.
+  You need to add an entry to https://github.com/grafana/writers-toolkit/tree/main/vale/dictionaries/en_US-grafana.wordlist to add a product name to the dictionary.
+  Alternatively, raise an [issue](https://github.com/grafana/writers-toolkit/issues/new?title=Grafana.Spelling%20%3A%20%3CWORD%3E) and a maintainer will add it for you.
+
   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.