chore(ci): Add Vale prose linting for documentation #18079
+274
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds Vale prose linting to complement the existing markdownlint setup. While markdownlint checks Markdown formatting, Vale checks prose style, grammar, and terminology consistency.
Changes
.vale.ini: Configuration using Google Developer Documentation Style Guide.vale/styles/Telegraf/: Custom rules for Telegraf documentation:Latin.yml: Flags Latin abbreviations (e.g., i.e., etc.) - suggest plain EnglishGrammar.yml: Flags common grammar issues ("allows to", "in order to", "In case")Terms.yml: Enforces correct product name capitalization (InfluxDB, Telegraf).github/workflows/vale.yml: Runs Vale on PR changes to Markdown filesdocs/developers/PROSE_STYLE.md: Documentation for contributorsCONTRIBUTING.md: Updated with Vale referenceHow it works
.mdfilesfail_on_error: false)Running locally
Test plan
vale ls-config)