keptn generate cloud-events-spec

keptn generate cloud-events-spec

Generates the markdown documentation for the Keptn CloudEvents

Synopsis

Generates markdown documentation for the Keptn CloudEvents.

This command can be used to create an up-to-date documentation of the Keptn CloudEvents documentation at https://github.com/keptn/spec/blob/master/cloudevents.md

It creates one markdown file containing a description of the CloudEvents as well as examples and json schema definitions.

keptn generate cloud-events-spec [flags]

Examples

keptn generate cloud-events-spec

keptn generate cloud-events-spec --dir=/some/directory

Options

      --dir string   directory where the cloud events spec should be written to (default "./ce-docs")

Options inherited from parent commands

  -h, --help               help
      --mock               Disables communication to a Keptn endpoint
  -n, --namespace string   Specify the namespace where Keptn should be installed, used and uninstalled in (default "keptn")
  -q, --quiet              Suppresses debug and info messages
  -v, --verbose            Enables verbose logging to print debug messages
  -y, --yes                Assume yes for all user prompts

SEE ALSO

  • keptn generate - Generates the markdown CLI documentation or a support archive
Auto generated by spf13/cobra on 25-Mar-2021