-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Automate CLI / func docs generation #5285
Comments
Also some discussion in #4430 |
Thanks @psschwei - it looks like some work was done on this but the previous issue was marked closed without it being really implemented; any idea why? |
Looks we decided on a WG call to just go with a link to the client repo. I vaguely recall running into some issues trying to automate moving the docs over here, but don't remember exactly what they were. |
I think the biggest issue with just having a link is that it doesn't allow us to retain different versions of the docs for different versions of |
I do like being able to refer to documentation by version, but using github doesn't prevent that. The docs are published with each change on |
@lance presumably we'd have to have some sort of script in the docs then to keep that link updated for each release though, or manually update it (IMO not an option, we already have issues with maintaining stuff like this accurately). |
The other issue IMHO is that using Github for docs isn't a very nice UX experience, but I guess that's not as urgent, especially while our sample docs still live there. I'd just prefer if long term we had a view to introduce more consistency in the docs experience, e.g. API ref docs are generated and included in the site, so why can't CLI, samples, etc be the same? |
Describe the change you'd like to see
The options for
kn
andfunc
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 forfunc
implementation after KubeCon (Oct 2022).The text was updated successfully, but these errors were encountered: