community icon indicating copy to clipboard operation
community copied to clipboard

[Tracking Issue] Developer Guide Audit

Open mrbobbytables opened this issue 5 years ago • 17 comments

Problem Documentation is the go-to reference for contributors. Parts of the developer guide have been cited as vastly out of date (e.g. referencing VERY outdated versions of docker). This puts up significant road blocks for contributors, either getting started or looking for best practices on how they should approach a problem.

Goal Audit the developer guide and note the sections that are out of date or are missing. The notes from the audit will be used to create targeted issues for updating the associated sections of the guide.

SIG Devel Guide Link Issue
API Machinery link #5230
Architecture link #5231
CLI link #5232
Instrumentation link #5233
Node link #5234
Release link #5235
Scalability link #5236
Scheduling link #5237
Storage link #5238
Testing link #5239

/sig contributor-experience /area developer-guide /milestone v1.20

mrbobbytables avatar Oct 16 '20 13:10 mrbobbytables

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale

fejta-bot avatar Feb 15 '21 18:02 fejta-bot

/remove-lifecycle stale

mrbobbytables avatar Mar 04 '21 14:03 mrbobbytables

do we need this for windows?

jayunit100 avatar Mar 09 '21 20:03 jayunit100

We have a doc here: https://github.com/kubernetes/community/blob/master/sig-windows/CONTRIBUTING.md should we move this to https://github.com/kubernetes/community/tree/master/contributors/devel?

jsturtevant avatar Mar 09 '21 21:03 jsturtevant

i just made a PR symlinking

jayunit100 avatar Mar 09 '21 21:03 jayunit100

https://github.com/kubernetes/community/pull/5621

jayunit100 avatar Mar 09 '21 21:03 jayunit100

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale

fejta-bot avatar Jun 07 '21 22:06 fejta-bot

/remove-lifecycle stale

mrbobbytables avatar Jun 07 '21 22:06 mrbobbytables

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

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

/lifecycle stale

k8s-triage-robot avatar Sep 20 '21 13:09 k8s-triage-robot

/remove-lifecycle stale

mrbobbytables avatar Sep 20 '21 21:09 mrbobbytables

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

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

/lifecycle stale

k8s-triage-robot avatar Dec 19 '21 21:12 k8s-triage-robot

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

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

/lifecycle rotten

k8s-triage-robot avatar Jan 18 '22 22:01 k8s-triage-robot

@mrbobbytables There are still a lot of open issues for this one. Maybe it needs another refresh/audit?

pymander avatar Jan 19 '22 18:01 pymander

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

This bot triages issues and PRs 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:

  • Reopen this issue or PR with /reopen
  • Mark this issue or PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close

k8s-triage-robot avatar Feb 18 '22 19:02 k8s-triage-robot

@k8s-triage-robot: Closing this issue.

In response to this:

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

This bot triages issues and PRs 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:

  • Reopen this issue or PR with /reopen
  • Mark this issue or PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close

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.

k8s-ci-robot avatar Feb 18 '22 19:02 k8s-ci-robot

/reopen /lifecycle frozen

mrbobbytables avatar May 03 '22 14:05 mrbobbytables

@mrbobbytables: Reopened this issue.

In response to this:

/reopen /lifecycle frozen

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.

k8s-ci-robot avatar May 03 '22 14:05 k8s-ci-robot