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

YAML files should comment out `...` #650

Open rohennes opened 1 year ago

rohennes commented 1 year ago

In OpenShift, we ask writers to comment out ellipses ... in YAML codeblocks when conveying truncated content. This is because ... has a special meaning in YAML. See SSG issue: https://github.com/redhat-documentation/supplementary-style-guide/issues/401

This may apply to RedHat style depending on the SSG resolution. It would perhaps require a Tengo scripting rule similar to https://github.com/redhat-documentation/vale-at-red-hat/blob/main/.vale/styles/AsciiDoc/ValidTableBlocks.yml

rohennes commented 1 year ago

https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#formatting

image