-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Automate CLI / func docs generation #5285
Copy link
Copy link
Open
Labels
kind/clikind/functionskind/site-improvementslifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.Indicates that an issue or PR should not be auto-closed due to staleness.priority/criticaltriage/needs-eng-implementationtriage/needs-eng-inputEngineering input is requestedEngineering input is requested
Metadata
Metadata
Labels
kind/clikind/functionskind/site-improvementslifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.Indicates that an issue or PR should not be auto-closed due to staleness.priority/criticaltriage/needs-eng-implementationtriage/needs-eng-inputEngineering input is requestedEngineering input is requested
Type
Projects
Status
Backlog
Status
Ready to work
Describe the change you'd like to see
The options for
knandfuncCLI commands are constantly being expanded and updated.It is not reasonable for docs to be manually updated frequently enough to keep up with the changes.
I would like to see folks on the eng team provide some method of implementation for auto-generating docs reference pages for the CLI tools that can be published on the website.
Additional context
Previously discussed with @rhuss for
knand with @lance forfuncimplementation after KubeCon (Oct 2022).