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

Add a Vale spelling rule #47970

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions .github/workflows/doc-tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,6 @@ jobs:
yarn install
yarn build-node

- name: Check spelling
run: cd $GITHUB_WORKSPACE/docs && yarn spellcheck content/teleport

- name: Lint the docs
run: cd $GITHUB_WORKSPACE/docs && yarn markdown-lint

Expand All @@ -111,7 +108,7 @@ jobs:
- name: Run the linter
uses: errata-ai/vale-action@38bf078c328061f59879b347ca344a718a736018 # v2.1.0
with:
version: 2.30.0
version: 3.8.0
# Take the comma-separated list of files returned by the "Check for
# relevant changes" job.
separator: ","
Expand Down
5 changes: 4 additions & 1 deletion docs/.vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@ MinAlertLevel = suggestion
mdx = md

[*.md]
BasedOnStyles = messaging,examples,3rd-party-products,structure
BasedOnStyles = messaging,examples,3rd-party-products,structure,spelling
# Allow ignoring vale style rules in MDX comments
CommentDelimiters = '{/*,*/}'

Loading
Loading