Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create provenanced command for generating provenanced documentation. #1468

Closed
4 tasks
SpicyLemon opened this issue Apr 10, 2023 · 0 comments · Fixed by #1688
Closed
4 tasks

Create provenanced command for generating provenanced documentation. #1468

SpicyLemon opened this issue Apr 10, 2023 · 0 comments · Fixed by #1688
Assignees
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

Comments

@SpicyLemon
Copy link
Contributor

Summary

Add a docgen sub-command to provenanced that is hidden and will generate documentation for the provenanced 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 of provenanced so that I don't have to spend time thinking about it, and it's done.

Proposal

Add a new docgen sub-command to provenanced.

  • It should have Hidden: true.
  • It should take in a directory path as an argument.
  • It should have flags for the various output types: --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.
  • If none of the output type flags are provided, just do markdown. If multiple are provided, do each provided.
  • It should use the built-in cobra docgen stuff: https://github.com/spf13/cobra/tree/main/doc

The command would be invoked like this:

$ provenanced docgen '/tmp' --yaml --markdown

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@SpicyLemon SpicyLemon added documentation Improvements or additions to documentation enhancement New feature or request nice-to-have Features not required in upcoming milestone CLI Command line interface feature labels Apr 10, 2023
@SpicyLemon SpicyLemon moved this from Todo to Backlog in Provenance Core Protocol Team Apr 10, 2023
@SpicyLemon SpicyLemon moved this from Backlog to Todo in Provenance Core Protocol Team Apr 10, 2023
@iramiller iramiller added this to the backlog milestone May 15, 2023
@SpicyLemon SpicyLemon modified the milestones: backlog, v1.17.0 May 30, 2023
@Taztingo Taztingo self-assigned this Sep 15, 2023
@Taztingo Taztingo moved this from Todo to In Progress in Provenance Core Protocol Team Sep 15, 2023
@Taztingo Taztingo mentioned this issue Sep 15, 2023
8 tasks
@github-project-automation github-project-automation bot moved this from In Progress to Done in Provenance Core Protocol Team Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
Development

Successfully merging a pull request may close this issue.

3 participants