Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
sget
, which also lives in this repo? This might change where we want generated docs to live.Ticket Link
n/a
Release Note