[FEATURE]Implement vocabulary and spelling linter in this repo #599
Comments
|
I attempted to add Vale in #620 and it does work. But I think it needs to become useful as the examples flagged seem to be mostly false positives using all the styles from documentation-website. Q: @kolchfa-aws is there a more minimal setup than copying something from documentation-website where we could begin to get value from vale? Where should I start?
|
|
That's what I meant: it flags all variables with underscores, etc. Normally, you can tell Vale to ignore those by adding a regex rule to |
|
@kolchfa-aws I opened errata-ai/vale#911, you obviously know more about this, add your comments there of what Vale could/would do for our use-case. |
|
Found a similar issue in errata-ai that I linked here |
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
TokenIgnoresin .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.
The text was updated successfully, but these errors were encountered: