search

aespinosa / cookbook-kube

Custom Chef resources to launch a Kubernetes cluster
https://supermarket.chef.io/cookbooks/kube
Apache License 2.0
32 stars 20 forks source link

Document the usage of custom resources #10

Closed aespinosa closed 7 years ago

aespinosa commented 8 years ago

The properties and corresponding documentation can be automatically generated similar how markdown documentation is being generated in https://github.com/kubernetes/kubernetes/blob/master/cmd/genkubedocs/gen_kube_docs.go#L51-L70.

Probably need an implementation equivalent to GenMarkdownTree but for custom Chef resource properties. See https://github.com/spf13/cobra/blob/master/doc/md_docs.md for reference

aespinosa commented 8 years ago

Related to discussion in #13 on how to autogenerate the properties during version changes.

aespinosa commented 7 years ago

Documentation released in v2.0.1