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

[FEATURE]Implement vocabulary and spelling linter in this repo #599

Open
kolchfa-aws opened this issue Oct 2, 2024 · 0 comments
Open

[FEATURE]Implement vocabulary and spelling linter in this repo #599

kolchfa-aws opened this issue Oct 2, 2024 · 0 comments
Labels
enhancement New feature or request untriaged

Comments

@kolchfa-aws
Copy link
Contributor

Is your feature request related to a problem?

We're currently working on generating documentation from this API spec. All changes to the text will be made in this repo. In the doc repo, we have added a Vale linter and a vocabulary specific to OpenSearch. We'd like to add a similar linter to this repo.

What solution would you like?

A linter to lint text in this repo and enforce spelling/grammar/punctuation rules.

What alternatives have you considered?

I have experimented with adding Vale itself to this repo. Vale treats yaml files as unsupported (default) files and lints line by line. As is, it produces lots of false positives. Some of those may be remedied by adding a pattern to TokenIgnores in .vale.ini, but I tried adding regexes for variables with underscores and camel case, and Vale still flagged those as errors.

Do you have any additional context?

Ideally, it would be great to add a linter that is designed to work with yaml files.

@kolchfa-aws kolchfa-aws added enhancement New feature or request untriaged labels Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request untriaged
Projects
None yet
Development

No branches or pull requests

1 participant