Create provenanced command for generating provenanced documentation. #1468
Labels
CLI
Command line interface feature
documentation
Improvements or additions to documentation
enhancement
New feature or request
nice-to-have
Features not required in upcoming milestone
Milestone
Summary
Add a
docgen
sub-command toprovenanced
that is hidden and will generate documentation for theprovenanced
command.Problem Definition
As a new or prospective user, I want to read about the
provenanced
commands before installing the program so that it's easier to learn about it.As a maintainer of
provenanced
, I want to auto-generate documentation for use ofprovenanced
so that I don't have to spend time thinking about it, and it's done.Proposal
Add a new
docgen
sub-command toprovenanced
.Hidden: true
.--markdown
,--yaml
,--rest
,--manpage
. It'd be nice to have a--json
option too, but since the cobra docgen stuff doesn't have that option, and writes the file(s) on its own, it might not be worth the effort.markdown
. If multiple are provided, do each provided.The command would be invoked like this:
$ provenanced docgen '/tmp' --yaml --markdown
For Admin Use
The text was updated successfully, but these errors were encountered: