-
Story
-
Resolution: Unresolved
-
Normal
-
None
-
None
-
Upstream
-
2
-
False
-
None
-
False
-
-
Add a carefully configured vale.ini to the https://github.com/netobserv/network-observability-operator/tree/main/docs folder. This allows you to run vale against source locally. The vale.ini should be tweaked to reduce false positives and not be annoying.
Test and check that it reports the common IBM style guide issues (if needed reach out to Sara for examples of what it should catch)
It's not necessary to add it to a github action or such, because our asciidoc isn't systematically generated. But we should add it either as a manual step in https://github.com/netobserv/network-observability-operator/blob/main/docs/GeneratingAsciidocAPI.md , or as an automated step in https://github.com/netobserv/network-observability-operator/blob/main/hack/asciidoc-gen.sh