kubernetes/sig-release

Enhance a template/checklist for KEP contributors to determine "Needs Docs"

drewhagen opened this issue · 2 comments

drewhagen commented

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.

k8s-triage-robot commented

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot commented

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:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle rotten
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten