Update CLI reference docs for v2.3.0#1097
Conversation
Use the new `crossplane generate-docs` command to generate CLI reference docs from the built-in CLI help. Update both `master` and `v2.3`, since they're the same for now. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
jbw976
left a comment
jbw976
left a comment
There was a problem hiding this comment.
there are a couple funny headings that are rendering odd, e.g. https://deploy-preview-1097--crossplane.netlify.app/v2.3/cli/command-reference/#read-the-xrd-from-stdin
are those at the right level? are they supposed to be headings? 🤔
Good catch - we missed properly converting the help for |
I've updated the CLI's docs generator locally to fix as many vale issues as possible and re-generated the docs using it. There are still a few issues we can't fix because of how our docs generation works: - The abbreviation `config` in the `crossplane config` command. - The abbreviation `k8s` in the flag help for `crossplane dependency add`. - The abbreviation `admin` in `cluster-admin` in the help for `crossplane project run`. Signed-off-by: Adam Wolfe Gordon <awg@upbound.io>
|
I've fixed as many vale issues as possible while still auto-generating docs. See crossplane/cli#30 for details. |
|
amazing @adamwg, great work at tackling most all of the vale issues! do you think it would be possible (or reasonable) to include exclusions in the CLI docs templates where needed for the specifically failing Vale styles, e.g. |
2 participants
Use the new
crossplane generate-docscommand to generate CLI reference docs from the built-in CLI help. Update bothmasterandv2.3, since they're the same for now.Toward #1092