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

Too many false positives for `Do not use 'config', unless it is followed by 'map'.` #305

Closed rolfedh closed 2 years ago

rolfedh commented 2 years ago

This Vale error log shows Do not use 'config', unless it is followed by 'map'. as one of the top ten errors.

Remove this rule and replace it with one that very specifically targets the incorrect forms, "configmap" and "configuration map," which are listed here: https://redhat-documentation.github.io/supplementary-style-guide/#config-map

Then, evaluate the following cases and see if we might add helpful suggestions or warnings for "config"

config-not-map.txt

rolfedh commented 2 years ago

.vale/styles/RedHat/ConfigMap.yml

aireilly commented 2 years ago

I think we should remove config map rule altogether: https://github.com/redhat-documentation/vale-at-red-hat/pull/319

rolfedh commented 2 years ago

@aireilly created and merged: https://github.com/redhat-documentation/vale-at-red-hat/pull/319 Let's consider this issue closed for now and open a new one if there are follow up issues.