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

Feature: automatically create docs for kwctl commands and flags #851

Open
viccuad opened this issue Jul 4, 2024 · 0 comments
Open

Feature: automatically create docs for kwctl commands and flags #851

viccuad opened this issue Jul 4, 2024 · 0 comments
Labels
area/ci area/community area/documentation Improvements or additions to documentation good first issue Good for newcomers kind/tech-debt

Comments

@viccuad
Copy link
Member

viccuad commented Jul 4, 2024

OpenSSF best practices asks us to document our API. As cli tool, that means kwctl commands and flags.

Acceptance criteria

Add a new kwctl docs, that outputs a Markdown or similar file with the docs for all our clap commands and flags. This can be achieved with clap-markdown.

On release, and after building kwctl, run kwctl docs and ship the resulting markdown file as GH artifact in the GH release.

Use updatecli to consume the new markdown doc file from the GH release, and automate its inclusion into the reference section of kubewarden/docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ci area/community area/documentation Improvements or additions to documentation good first issue Good for newcomers kind/tech-debt
Projects
Status: No status
Development

No branches or pull requests

1 participant