Enhance a template/checklist for KEP contributors to determine "Needs Docs" #2595
Labels
kind/documentation
Categorizes issue or PR as related to documentation.
lifecycle/stale
Denotes an issue or PR has remained open with no activity and has become stale.
priority/backlog
Higher priority than priority/awaiting-more-evidence.
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: