Merge pull request #2939 from MikeJeffrey/101

Update docs/README.md: add TOC / doc descriptions.
2025-07-23 19:56:01 +00:00 · 2014-12-15 11:07:46 -08:00 · 2014-12-15 11:07:46 -08:00 · c1d10826c0
commit c1d10826c0
parent f81b6b218e f5a2e2637c
1 changed files with 104 additions and 26 deletions
--- a/docs/README.md
+++ b/docs/README.md
@ -1,29 +1,107 @@
 # Kubernetes Documentation

-Kubernetes documentation is organized into several categories.
+* [Primary concepts](#primary-concepts)
+* [Additional user guides](#additional-user-guides)
+
+
+Getting started guides are in [getting-started-guides](getting-started-guides).
+
+There are example files and walkthroughs in the [examples](../examples) folder.
+
+If you're developing Kubernetes, docs are in the [devel](devel) folder.
+
+Design docs are in [design](design).
+
+## Primary concepts
+
+* **Overview** ([overview.md](overview.md)): A brief overview
+  of Kubernetes concepts. 
+
+* **Nodes** ([node.md](node.md)): A node is a worker machine in Kubernetes.
+
+* **Pods** ([pods.md](pods.md)): A pod is a tightly-coupled group of containers
+  with shared volumes.
+
+* **The Life of a Pod** ([pod-states.md](pod-states.md)):
+  Covers the intersection of pod states, the PodStatus type, the life-cycle
+  of a pod, events, restart policies, and replication controllers.
+
+* **Replication Controllers** ([replication-controller.md](replication-controller.md)):
+  A replication controller ensures that a specified number of pod "replicas" are 
+  running at any one time.
+
+* **Services** ([services.md](services.md)): A Kubernetes service is an abstraction 
+  which defines a logical set of pods and a policy by which to access them.
+
+* **Volumes** ([volumes.md](volumes.md)): A Volume is a directory, possibly with some 
+  data in it, which is accessible to a Container.
+
+* **Labels** ([labels.md](labels.md)): Labels are key/value pairs that are 
+  attached to objects, such as pods. Labels can be used to organize and to 
+  select subsets of objects. 
+
+* **Accessing the API** ([accessing_the_api.md](accessing_the_api.md)):
+  Ports, IPs, proxies, and firewall rules.
+
+* **Kubernetes Web Interface** ([ux.md](ux.md)): Accessing the Kubernetes
+  web user interface.
+
+* **Kubecfg Command Line Interface** ([cli.md](cli.md)):
+  The `kubecfg` command line reference.
+
+* **Roadmap** ([roadmap.md](roadmap.md)): The set of supported use cases, features,
+  docs, and patterns that are required before Kubernetes 1.0.
+
+* **Glossary** ([glossary.md](glossary.md)): Terms and concepts.
+
+
+## Further reading
+
+
+* **Annotations** ([annotations.md](annotations.md)): Attaching
+  arbitrary non-identifying metadata.
+
+* **API Conventions** ([api-conventions.md](api-conventions.md)):
+  Defining the verbs and resources used in the Kubernetes API.
+
+* **Authentication Plugins** ([authentication.md](authentication.md)):
+  The current and planned states of authentication tokens.
+
+* **Authorization Plugins** ([authorization.md](authorization.md)):
+  Authorization applies to all HTTP requests on the main apiserver port.
+  This doc explains the available authorization implementations.
+
+* **API Client Libraries** ([client-libraries.md](client-libraries.md)):
+  A list of existing client libraries, both supported and user-contributed.
+
+* **Kubernetes Container Environment** ([container-environment.md](container-environment.md)):
+  Describes the environment for Kubelet managed containers on a Kubernetes
+  node.
+
+* **DNS Integration with SkyDNS** ([dns.md](dns.md)):
+  Resolving a DNS name directly to a Kubernetes service.
+
+* **Identifiers** ([identifiers.md](identifiers.md)): Names and UIDs
+  explained.
+
+* **Images** ([images.md](images.md)): Information about container images
+  and private registries.
+
+* **Logging** ([logging.md](logging.md)): Pointers to logging info.
+
+* **Namespaces** ([namespaces.md](namespaces.md)): Namespaces help different
+  projects, teams, or customers to share a kubernetes cluster.
+
+* **Networking** ([networking.md](networking.md)): Pod networking overview.
+
+* **OpenVSwitch GRE/VxLAN networking** ([ovs-networking.md](ovs-networking.md)):
+  Using OpenVSwitch to set up networking between pods across
+  Kubernetes nodes.
+
+* **The Kubernetes Resource Model** ([resources.md](resources.md)):
+  Provides resource information such as size, type, and quantity to assist in
+  assigning Kubernetes resources appropriately.
+
+* **Using Salt to configure Kubernetes** ([salt.md](salt.md)): The Kubernetes
+  cluster can be configured using Salt.

-  - **Getting Started Guides**
-    - for people who want to create a kubernetes cluster
-    - in [docs/getting-started-guides](./getting-started-guides)
-  - **User Documentation**
-    - in [docs](./overview.md)
-    - for people who want to run programs on kubernetes
-    - describes current features of the system (with brief mentions of planned features)
-  - **Developer Documentation**
-    - in [docs/devel](./devel)
-    - for people who want to contribute code to kubernetes
-    - covers development conventions
-    - explains current architecture and project plans
-  - **Design Documentation**
-    - in [docs/design](./design)
-    - for people who want to understand the design choices made
-    - describes tradeoffs, alternative designs
-    - descriptions of planned features that are too long for a github issue.
-  - **Walkthroughs and Examples**
-    - in [examples](../examples)
-    - Hands on introduction and example config files
-  - **API documentation**
-    - in [the API conventions doc](api-conventions.md)
-    - 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))
-  - **Wiki**
-    - in [wiki](https://github.com/GoogleCloudPlatform/kubernetes/wiki)