Add a Vale spelling rule #47970
Draft
Add a Vale spelling rule #47970
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closes #46191 This change adds a Vale spelling rule that replaces the current cspell workflow. The Vale spelling rule ignores spelling errors in code-style text by default, and includes more configuration options for filtering spelling errors. This also allows us to reduce the number of linting workflows. This change also adds a file containing words to ignore in the spellcheck rule, based on the current `cspell.json`. While this change introduces new spelling errors, we can remove these incrementally, since the Vale spellchecker only flags issues in files changed by a PR. This change also configures the Vale spellcheck rule to ignore abbreviations. For consistency with the cspell configuration, this change ignores spelling errors in Terraform and Kubernetes operator reference pages. To do so, it adds the `{/* vale spelling.spelling = OFF */}` comment directive in relevant auto-generated reference pages.
ptgott
force-pushed
the
paul.gottschling/46191-spelling
branch
from
7bd4a2e to
a52ff2d
Compare
|
This PR depends on #47907, so I am putting it in draft. |
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
|
🤖 Vercel preview here: https://docs-mfl1gspkw-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-4aipi6b3c-goteleport.vercel.app/docs/ver/preview |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #46191
This change adds a Vale spelling rule that replaces the current cspell workflow. The Vale spelling rule ignores spelling errors in code-style text by default, and includes more configuration options for filtering spelling errors. This also allows us to reduce the number of linting workflows.
This change also adds a file containing words to ignore in the spellcheck rule, based on the current
cspell.json.While this change introduces new spelling errors, we can remove these incrementally, since the Vale spellchecker only flags issues in files changed by a PR.
This change also configures the Vale spellcheck rule to ignore abbreviations.
For consistency with the cspell configuration, this change ignores spelling errors in Terraform and Kubernetes operator reference pages. To do so, it adds the
{/* vale spelling.spelling = OFF */}comment directive in relevant auto-generated reference pages.