Kubernetes documentation is organized into several categories.
*[Primary concepts](#primary-concepts)
*[Additional user guides](#additional-user-guides)
-**Getting Started Guides**
- for people who want to create a kubernetes cluster
- in [docs/getting-started-guides](./getting-started-guides)
Getting started guides are in [getting-started-guides](getting-started-guides).
-**User Documentation**
- in [docs](./overview.md)
There are example files and walkthroughs in the [examples](../examples) folder.
- for people who want to run programs on kubernetes
- describes current features of the system (with brief mentions of planned features)
If you're developing Kubernetes, docs are in the [devel](devel) folder.
-**Developer Documentation**
- in [docs/devel](./devel)
Design docs are in [design](design).
- for people who want to contribute code to kubernetes
- covers development conventions
## Primary concepts
- explains current architecture and project plans
-**Design Documentation**
***Overview** ([overview.md](overview.md)): A brief overview
- in [docs/design](./design)
of Kubernetes concepts.
- for people who want to understand the design choices made
- describes tradeoffs, alternative designs
***Nodes** ([node.md](node.md)): A node is a worker machine in Kubernetes.
- descriptions of planned features that are too long for a github issue.
-**Walkthroughs and Examples**
***Pods** ([pods.md](pods.md)): A pod is a tightly-coupled group of containers
- in [examples](../examples)
with shared volumes.
- Hands on introduction and example config files
-**API documentation**
***The Life of a Pod** ([pod-states.md](pod-states.md)):
- in [the API conventions doc](api-conventions.md)
Covers the intersection of pod states, the PodStatus type, the life-cycle
- and automatically generated API documentation served by the master at `/swaggerapi/api/v1beta1` (generated from [pkg/api/v1beta1/types.go](../pkg/api/v1beta1/types.go))
of a pod, events, restart policies, and replication controllers.
-**Wiki**
- in [wiki](https://github.com/GoogleCloudPlatform/kubernetes/wiki)