Add Vale workflow to lint prose on added/modified lines #604
Conversation
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
jdbaldry
changed the title
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -21,9 +21,12 @@ aliases: | |||
|
|
|||
| ## eBPF application auto-instrumentation | |||
|
|
|||
| Instrumenting an application to obtain metrics and traces typically requires adding a language agent to the application deployment/packages. In some compiled languages like Go or Rust, tracepoints have to be manually added to the code. In both cases, the instrumented version of the application must be redeployed to the staging/production servers. | |||
| Instrumenting an application to obtain metrics and traces typically requires adding a language agent to the application deployment/packages. | |||
| In some compiled languages like Go or Rust, you must manually add tracepoints to the code. | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Grafana.Spelling] Did you really mean 'tracepoints'? For UI elements, use bold formatting. 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. The spell checker doesn't check words with code formatting.
If the rule is incorrect or needs improving, report an issue.
If you have reason to diverge from the style guidance, to skip a rule, refer to Skip rules.
There was a problem hiding this comment.
I've left this in demonstrate that the rules are not perfect yet :)
Would you like tracepoint(s) to be added to the dictionary for Grafana?
I did a search and it seems to be a well established term in the context of debugging.
There was a problem hiding this comment.
Yes please, that would be great!
There was a problem hiding this comment.
I've opened grafana/writers-toolkit#460 which I'll merge and then re-run CI here to make sure it passes.
|
Let's give it a whirl :) |
|
oh, didn't see this, thanks @jdbaldry ! |
Please be prepared to provide a lot of feedback on the linter in https://github.com/grafana/writers-toolkit/issues.
It's not perfect and will have plenty of false positives.
If error messages are confusing or poorly justified, that is also worthy of an issue. I want Vale to feel like it is educational rather than punishing.
Something like
shellcheckis for shell scripts.Signed-off-by: Jack Baldry jack.baldry@grafana.com