knative / knative/docs

Automate CLI / func docs generation

Open
#5,285 7 comments 0 reactions 2 assignees Assigned to @lance View on GitHub
kind/cli kind/functions kind/site-improvements lifecycle/frozen priority/critical triage/needs-eng-implementation triage/needs-eng-input
Dominant language
HTML
Stars
5.1k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

Description

**Describe the change you'd like to see**
The options for `kn` and `func` CLI 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 `kn` and with @lance for `func` implementation after KubeCon (Oct 2022).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.