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

Generate Markdown docs for cosign #839

Merged
merged 1 commit into from
Oct 4, 2021
Merged

Conversation

imjasonh
Copy link
Member

@imjasonh imjasonh commented Oct 4, 2021

Summary

Now that #706 is closed (👏 @n3wscott), we can use cobra's built-in doc generation to make Markdown docs available for cosign.

Example: https://github.com/imjasonh/cosign/blob/gendoc/doc/cosign.md

This makes it easier to reference CLI surfaces in docs and in conversation.

This also adds a CI check to ensure new surface changes are accompanied by doc regeneration.

Open Questions:

  • Do we also want to generate docs for sget, which also lives in this repo? This might change where we want generated docs to live.

Ticket Link

n/a

Release Note

cosign has generated Markdown docs available in the doc/ directory.

Signed-off-by: Jason Hall <jasonhall@redhat.com>
Copy link
Contributor

@n3wscott n3wscott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is really awesome!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants