Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Umbrella issue - Revamping the Kubernetes Developer’s guide #3064
The contributor guide has been revamped. This is a mostly general guide for all who are getting ramped up on Kubernetes upstream contributions. We need to produce a section of that with the name “The developer guide”
This issue is an umbrella tracking issue.
We are going to build this thinking of two personas:
This initial work will be focused on the understanding of the internals required by persona 1. It is important to have a sense of how they come together to form a functional cluster and how that is used.
As a new developer, the following are the things I would like to read first in order to become familiar with the project:
Both Persona 1 and 2 have in common the previous points.
Specific points for each persona:
Persona 1 (Code Contributor)
Persona 2 (Platform Developer)
To help out
Files to review
Files in the contributors/devel need to be scrubbed for the developer guide. Non-developer relevant topics should be moved over to other parts of the contributor repo or just be deleted. There might be some calls to make.
Duplicate content that can be removed.
Pages to update
Folders to update
I will be updating this issue on a daily basis.
This was referenced
Jan 2, 2019
Thank you so much for this, @eduartua! A couple thoughts, in no particular order:
At the danger of repeating others, I want to point out the Python Developer Guide as a fantastic example of a very useable, helpful dev guide.
Please ping me (here or on Slack) about files that are more a contributor guide topic than a technical dev guide topic that need to be deleted or still incorporated - I'm thinking
In addition to
I'm super excited for a top-level README to tell me where to build WHAT.
Looking good to me for a start! A few small comments:
might better be:
In the deploy and run section I think some treatment needs given to the multitude of host platforms on which one might run. This also then relates to cloud provider code. I'm curious if @andrewsykim has thoughts on where best cloud provider developer content might fit into the guide.
The Testing section probably should include a "conformance" section in addition to unit, integration and e2e. I see them as a sort of continuum: unit, integration, e2e, conformance.
Debugging: This is a very broad section. It might make sense to seed some sub-categories, eg: control plane component specific, network communications, and client side.
Security: Especially thinking about recent CVEs, I think it's critically important to give developers a sense of the general thread model against a running Kubernetes cluster and the implications