kubernetes / kubernetes/community

[Tracking Issue] Developer Guide Audit

Open
#5,229 17 comments 0 reactions 0 assignees View on GitHub
area/developer-guide kind/documentation lifecycle/frozen sig/contributor-experience
Dominant language
Jupyter Notebook
Stars
13k
Forks
5.4k
Avg merge
2d 17h
Merged PRs (30d)
29

Description

**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](https://github.com/kubernetes/community/tree/master/sig-api-machinery) | [link](https://github.com/kubernetes/community/tree/master/contributors/devel/sig-api-machinery) | [#5230](https://github.com/kubernetes/community/issues/5230) |
| [Architecture](https://github.com/kubernetes/community/tree/master/sig-architecture) | [link](https://github.com/kubernetes/community/tree/master/contributors/devel/sig-architecture) | [#5231](https://github.com/kubernetes/community/issues/5231) |
| [CLI](https://github.com/kubernetes/community/tree/master/sig-cli) | [link](https://github.com/kubernetes/community/tree/master/contributors/devel/sig-cli) | [#5232](https://github.com/kubernetes/community/issues/5232) |
| [Instrumentation](https://github.com/kubernetes/community/tree/master/sig-instrumentation) | [link](https://github.com/kubernetes/community/tree/master/contributors/devel/sig-instrumentation) | [#5233](https://github.com/kubernetes/community/issues/5233) |
| [Node](https://github.com/kubernetes/community/tree/master/sig-node) | [link](https://github.com/kubernetes/community/tree/master/contributors/devel/sig-node) | [#5234](https://github.com/kubernetes/community/issues/5234) |
| [Release](https://github.com/kubernetes/community/tree/master/sig-release) | [link](https://github.com/kubernetes/community/tree/master/contributors/devel/sig-release) | [#5235](https://github.com/kubernetes/community/issues/5235) |
| [Scalability](https://github.com/kubernetes/community/tree/master/sig-scalability) | [link](https://github.com/kubernetes/community/tree/master/contributors/devel/sig-scalability) | [#5236](https://github.com/kubernetes/community/issues/5236) |
| [Scheduling](https://github.com/kubernetes/community/tree/master/sig-scheduling) | [link](https://github.com/kubernetes/community/tree/master/contributors/devel/sig-scheduling) | [#5237](https://github.com/kubernetes/community/issues/5237) |
| [Storage](https://github.com/kubernetes/community/tree/master/sig-storage) | [link](https://github.com/kubernetes/community/tree/master/contributors/devel/sig-storage) | [#5238](https://github.com/kubernetes/community/issues/5238) |
| [Testing](https://github.com/kubernetes/community/tree/master/sig-testing) | [link](https://github.com/kubernetes/community/tree/master/contributors/devel/sig-testing) | [#5239](https://github.com/kubernetes/community/issues/5239) |

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

Contributor guide

Open the contributing guide

Research direction

Read the developer-guide directories linked for the ten SIGs under contributors/devel and review the related issues #5230–#5239. Record outdated or missing sections, especially obsolete Docker references, and consider the audit complete when each finding is documented for a targeted follow-up issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.