vela def gen-doc

Generate documentation for non component, trait, policy and workflow definitions

Synopsis

Generate documentation for non component, trait, policy and workflow definitions

vela def gen-doc [flags] SOURCE.cue...

Examples

1. Generate documentation for provider definitions
> vela def gen-doc -t provider provider1.cue provider2.cue > provider.md

Options

  -h, --help          help for gen-doc
  -t, --type string   Type of the definition to generate. Valid types: [provider]

Options inherited from parent commands

  -V, --verbosity Level   number for the log level verbosity
  -y, --yes               Assume yes for all user prompts

SEE ALSO

• vela def - Manage definitions.

Go Back to CLI Commands Homepage.

Auto generated by spf13/cobra script in KubeVela.