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

Integrate rules for validating AsciiDoc

Open themr0c opened this issue 3 years ago • 3 comments

Test and integrate modular docs rules created by @jhradilek: https://github.com/jhradilek/vale-modular-docs


Edit from @rohennes - we are working on https://github.com/rohennes/ocp-rules to meet the same ask, so using this issue as a tracker for the work on this repo

themr0c avatar Nov 23 '21 14:11 themr0c

Not every content follows the modular docs guidelines. Therefore, ensure they don't generate error or warnings, at least with the default configuration file.

themr0c avatar Dec 03 '21 15:12 themr0c

@jhradilek - I have been working on what I think is the same idea. See this repo: https://github.com/rohennes/ocp-rules Great minds think alike! :-p

The goal is for this rule set to exist as a separate package to the RedHat rule set. If it's OK with you, can I incorporate any rules in your repo that I didn't think of into my repo? I think a few of the rules are the same actually... e.g. check for context variable in IDs.

Or feel free to create a PR if you want to add to my repo. My repo is slightly OCP specific at this point but I am trying to make it more generic so it can be applied across teams. FYI - the rules in my repo apply to modules only.

rohennes avatar Dec 02 '22 14:12 rohennes

For the record, not taking anything from Jaromír's repo at present. Two of the rules in Jaromír's repo relating to modules are present in the ocp-rules repo. Although it is worth noting these rules use a different style: they extend the conditional style rather than the existence style.

The other two rules are for assemblies, but also worth noting if we ever get around to making rules, or a rule-set, for assemblies.

rohennes avatar Dec 07 '22 16:12 rohennes