-
Notifications
You must be signed in to change notification settings - Fork 397
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
Enhance a template/checklist for KEP contributors to determine "Needs Docs" #2595
Comments
The Kubernetes project currently lacks enough contributors to adequately respond to all issues. This bot triages un-triaged issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues. This bot triages un-triaged issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle rotten |
The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs. This bot triages issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /close not-planned |
@k8s-triage-robot: Closing this issue, marking it as "Not Planned". 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-sigs/prow repository. |
Feature Request
Create or enhance a template/checklist with clear requirements for "needs docs" for a KEP.
Background
Each cycle, shadows and lead of Release Docs reaches out to the author and ask if they need documentation for their KEP. There is a simple template in our docs handbook that is copy/pasted into the KEP asking if they need docs and if so, open up a placeholder PR by a deadline.
However, this template doesn't provide KEP contributors much guidance about when docs are required.
Why this is Needed
While most SIGs know that contributing a feature gate requires documentation, we've still had some that have gone undocumented in recent cycles. The requirement to document feature gates is one example of something we can communicate guidance on. (maybe we can think of others? idk - might need to ask SIG Docs)
Alternative
An alternative is to ask SIG Docs to provide more clarity on when docs are required on this page on the website:
https://kubernetes.io/docs/contribute/new-content/new-features/#for-developers-or-other-sig-members
Release Docs's outreach includes a link to this page about opening a placeholder PR/
If we got that route, we should open an issue on the website repo and communicate with SIG Docs.
The text was updated successfully, but these errors were encountered: