search

redhat-documentation / vale-at-red-hat

Vale config files, styles, and docs to help individuals and teams roll out Vale
https://redhat-documentation.github.io/vale-at-red-hat/
MIT License
39 stars 59 forks source link

When "config" is preceded by "Ignition" it should be allowed #272

Closed mjpytlak closed 2 years ago

mjpytlak commented 2 years ago

Describe the bug "Ignition config" is a valid RHCOS term, but is being flagged.

Examples:

To Reproduce Steps to reproduce the behavior:

  1. Add this word or expression: Ignition config
  2. Vale reports an illegitimate alert: error

Expected behavior "Ignition config" is not reported as an error.

Additional context While the Red Hat Supplementary style guide does not list this combination as valid, I have confirmed with Kathryn Alexander that this is an approved item.

aireilly commented 2 years ago

could we use a Vocab with accept.txt and an [Ii]gnition config entry to fix this?

https://vale.sh/docs/topics/vocab/

rolfedh commented 2 years ago

@aireilly resolved, or more to do for this issue?

aireilly commented 2 years ago

Not resolved - we don't want to use vocabs in our rules. I think we need to throw out the config map rule and create simple spelling exceptions for the various config terms we want to allow.

aireilly commented 2 years ago

Fixed in https://github.com/redhat-documentation/vale-at-red-hat/pull/319