Conversation
pquentin
left a comment
There was a problem hiding this comment.
Thanks! LGTM. I used Vale recently, and some suggestions are pretty good. I applied some of them in #3324.
But there's also a lot of noise. In the DSL client, we execute queries; this is even in the API, but Vale doesn't like it, for example.
|
Interesting. Could you provide some examples? In theory, Vale only lints Markdown changed lines and ignores code blocks. |
|
Right, I'm talking about what Vale adds to the "Problems" tab in my editor. For example, we use "via" a lot and it doesn't like it. There are many words like this. Consider this sentence:
Vale suggests replacing "see" with "refer to" but that never works. Another example:
Vale suggests replacing "In addition" with "Also", which doesn't work. Regarding execute, we have a lot of sentences like this:
It would be nice to silent some rules or allow some words on a per-project basis to avoid all the squiggly lines. |
|
Point taken! Could you raise some issues in the vale-rules repo? |
This PR adds support for Vale docs linting to the repository. Linting only triggers when Markdown files inside the docs folder are edited. Vale linting never blocks pull requests. For more information, refer to Vale linter.
Contributes to https://github.com/elastic/docs-content-internal/issues/670