Skip to content

Commit

Permalink
Add explanation for resolving product name linting issues (#475)
Browse files Browse the repository at this point in the history
  • Loading branch information
jdbaldry authored Feb 13, 2024
1 parent 0fdfd63 commit 4b6a118
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions vale/Grafana/Spelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 4b6a118

Please sign in to comment.