Linting the Buildkite Docs
The text discusses how to improve inclusivity in documentation by using tools like alex and vale. Alex is a one-stop NodeJS tool for catching insensitive or inconsiderate writing, while Vale is a syntax-aware linter for prose built with speed and extensibility in mind. Both tools can be configured to run various checks on the documentation and can be integrated into CI/CD pipelines like Buildkite. The author demonstrates how to use these tools to identify and correct insensitive language, spelling mistakes, and inconsistencies in writing style. They also provide examples of how to configure these tools for specific file formats and ignore certain parts of the documentation when necessary.
Company
Buildkite
Date published
Sept. 7, 2020
Author(s)
Sam Wright
Word count
1206
Hacker News points
None found.
Language
English