vale-at-red-hat icon indicating copy to clipboard operation
vale-at-red-hat copied to clipboard

Incorporate Red Hat official product list terminology and do not use terms into Vale rules

Open aireilly opened this issue 3 years ago • 4 comments

Incorporate RH official product list terminology and do not use terms into Vale rules:

https://docs.google.com/spreadsheets/d/1DLS_lS3VKidgZIvcLmLp9BoiqptkvqHWfe1D5FD2kfk/edit#gid=1259317633

Example:

Red Hat Quay | RHQ, RHCR

Always use full product name on first use and whenever clarity is needed. After first use, you can use the short name: Quay

aireilly avatar Feb 14 '22 11:02 aireilly

This is a complex task. Here some ideas:

  • Ensure all product names don't raise errors in the Spelling rule: add all product names in https://github.com/redhat-documentation/vale-at-red-hat/blob/main/.vale/fixtures/RedHat/Spelling/testvalid.adoc and when necessary fix https://github.com/redhat-documentation/vale-at-red-hat/blob/main/.vale/styles/RedHat/Spelling.yml

  • Add all case-sensitive terms in https://github.com/redhat-documentation/vale-at-red-hat/blob/main/.vale/styles/RedHat/CaseSensitiveTerms.yml

  • For first ... second occurrences, we'll need a new rule, that can be inspired from: https://github.com/redhat-documentation/vale-at-red-hat/blob/main/.vale/styles/RedHat/Definitions.yml

themr0c avatar Feb 14 '22 14:02 themr0c

Does it make sense to manage these a single rules file, RedHatProducts.yml or similiar?

aireilly avatar Feb 14 '22 15:02 aireilly

@themr0c OK yes I see what you are saying. Cool! Will try and get something together this week.

aireilly avatar Feb 14 '22 19:02 aireilly

+1 to a fix for this issue.

I am seeing a lot of orange warnings throughout my content as many Red Hat products are detected as misspellings, for example, "Infinispan". In some cases, I have 30+ warnings for legitimate product warnings, which makes me tempted to reconfigure vale to just errors only, which is a risk.

https://github.com/redhat-documentation/vale-at-red-hat/issues/203

michelle-purcell avatar Apr 21 '22 07:04 michelle-purcell