Skip to content

Add Vale docs linting support#3331

Merged
theletterf merged 1 commit intomainfrom
add-vale-linting
Feb 24, 2026
Merged

Add Vale docs linting support#3331
theletterf merged 1 commit intomainfrom
add-vale-linting

Conversation

@theletterf
Copy link
Contributor

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

Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@theletterf
Copy link
Contributor Author

Interesting. Could you provide some examples? In theory, Vale only lints Markdown changed lines and ignores code blocks.

@pquentin
Copy link
Member

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:

In this example, you can see:

Vale suggests replacing "see" with "refer to" but that never works. Another example:

In addition to these, query_vector or query_vector_builder must be given as well.

Vale suggests replacing "In addition" with "Also", which doesn't work. Regarding execute, we have a lot of sentences like this:

You can execute your search by calling the .execute() method that will return a Response object.

It would be nice to silent some rules or allow some words on a per-project basis to avoid all the squiggly lines.

@theletterf theletterf marked this pull request as ready for review February 24, 2026 13:52
@theletterf
Copy link
Contributor Author

Point taken! Could you raise some issues in the vale-rules repo?

@theletterf theletterf merged commit 7f3e6b6 into main Feb 24, 2026
22 of 23 checks passed
@theletterf theletterf deleted the add-vale-linting branch February 24, 2026 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants