Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: testing: add vale styles #1474

Conversation

esmerel
Copy link
Contributor

@esmerel esmerel commented Oct 17, 2024

This PR adds Vale, an open source docs linter. This is aimed at helping ensure spell checks, consistent wording, and a number of general grammar checks based on Google's style guide.

These tests are all at the 'suggestion' level, and will are not required. They should not break any testing, and vale is limited to running on the following file types: md,markdown,txt,htm,html.

Signed-off-by: Lynette Miles <[email protected]>
@esmerel esmerel marked this pull request as ready for review October 17, 2024 20:05
@esmerel esmerel requested review from a team as code owners October 17, 2024 20:05
Copy link
Contributor

@cnorris-cs cnorris-cs left a comment

Choose a reason for hiding this comment

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

Several of the lines at the end of the exception list aren't needed, but they also don't hurt anything. I'm approving this so that Vale tests of the content can happen.

@esmerel esmerel merged commit 9b70181 into master Oct 17, 2024
3 checks passed
@esmerel esmerel deleted the lynettemiles/sc-113209/add-vale-styles-and-vale-ini-to-fluent-bit branch October 17, 2024 20:14
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