-
Notifications
You must be signed in to change notification settings - Fork 14.4k
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
Update /docs/contribute/generate-ref-docs #14111
Comments
Ping me if anything I can help. |
Hello Jim and Tengqm, I am interested to work on this issue. Thanks |
@jimangel - this issue is open on the 1.15 milestone - is this planning to happen in the 1.15 release? |
@claurence - detaching from the milestone to not affect the Docs deadline. I will add to the 1.16 milestone; if not resolved before then. Thanks! |
Hello. I will update the documentation for generating the API reference and sync up with @jimangel 's cheatsheet. Which format is easier to follow? I am somewhat in favor of the less verbose, task-oriented instructions. Let me know what you think. I will temporarily assign this issue to myself. |
@kbhawkey @tengqm @makoscafee - It sounds like there is work underway to improve process and surrounding documentation, thanks! @simplytunde - This has been a major issue for the past 2 releases. Please keep up with this discussion and I would strongly encourage you trying to generate the 1.15 docs again (for testing when 1.16 is ready). |
* Update api reference contrib doc See issue #14111 * updates to api ref contrib guide * further updates to api ref contrib * more updates api ref contrib
@simplytunde: The provided milestone is not valid for this repository. Milestones in this repository: [ Use In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
Stale issues rot after 30d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
/remove-lifecycle rotten |
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
This is a Feature Request
Review https://kubernetes.io/docs/contribute/generate-ref-docs/kubernetes-api/ and https://kubernetes.io/docs/contribute/generate-ref-docs/kubernetes-components/ for technical accuracy. At it's current state it's currently not usable.
What would you like to be added
Why is this needed
To make it easier for the sig-docs release lead to generate ref docs content.
Comments
I can own this, but have some backlog to clear out first before I can get to it. If there's someone who's available now to tackle this sooner, I'm happy to work with you!
/cc @makoscafee @tengqm
The text was updated successfully, but these errors were encountered: