What problem are you facing?
The help text built into the CLI (detailed markdown help as well as flag and command descriptions) gets used to generate the CLI reference docs. The docs repository uses the vale tool to lint prose. It is very likely we will write help docs that violate the vale rules and not notice until we've already merged the offending help.
How could Crossplane help solve your problem?
We should add a CI check that runs crossplane generate-docs and then uses the docs repository's vale config to lint the result. This would let us know if there's anything we need to fix before officially updating the docs, and also help make our help text more consistent with the Crossplane documentation.
What problem are you facing?
The help text built into the CLI (detailed markdown help as well as flag and command descriptions) gets used to generate the CLI reference docs. The docs repository uses the vale tool to lint prose. It is very likely we will write help docs that violate the vale rules and not notice until we've already merged the offending help.
How could Crossplane help solve your problem?
We should add a CI check that runs
crossplane generate-docsand then uses the docs repository's vale config to lint the result. This would let us know if there's anything we need to fix before officially updating the docs, and also help make our help text more consistent with the Crossplane documentation.