kubernetes/docs/README.md

# Kubernetes Documentation: releases.k8s.io/HEAD

* The [User's guide](user-guide/README.md) is for anyone who wants to run programs and
  services on an existing Kubernetes cluster.

* The [Cluster Admin's guide](admin/README.md) is for anyone setting up
  a Kubernetes cluster or administering it.

* The [Developer guide](devel/README.md) is for anyone wanting to write
  programs that access the Kubernetes API, write plugins or extensions, or
  modify the core code of Kubernetes.

* The [Kubectl Command Line Interface](user-guide/kubectl/kubectl.md) is a detailed reference on
  the `kubectl` CLI.

* The [API object documentation](api-reference/README.md)
  is a detailed description of all fields found in core API objects.

* An overview of the [Design of Kubernetes](design/)

* There are example files and walkthroughs in the [examples](../examples/)
  folder.

* If something went wrong, see the [troubleshooting](http://kubernetes.io/docs/troubleshooting/) guide for how to debug.
You should also check the [known issues for the release](../CHANGELOG.md) you're using.

* To report a security issue, see [Reporting a Security Issue](reporting-security-issues.md).


<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/README.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS -->
Revert "Versioning docs and examples for v1.4.0-alpha.0." This reverts commit cce9db3aa9555671c5ddf69549b46ed0fd7e472a. 2016-06-10 19:46:46 -04:00			`# Kubernetes Documentation: releases.k8s.io/HEAD`
Add some text about the docs being sync'd to HEAD Add pointers to the release branch files. Clone docs when creating a new release. 2015-06-05 00:18:30 -04:00
Initial TOC for the user guide. 2015-07-14 13:24:12 -04:00			`* The [User's guide](user-guide/README.md) is for anyone who wants to run programs and`
reflow lines 2015-07-07 18:41:43 -04:00			`services on an existing Kubernetes cluster.`
Update docs/README.md: add TOC / doc descriptions. 2014-12-15 13:43:17 -05:00
move admin related docs into docs/admin 2015-07-09 16:33:48 -04:00			`* The [Cluster Admin's guide](admin/README.md) is for anyone setting up`
reflow lines 2015-07-07 18:41:43 -04:00			`a Kubernetes cluster or administering it.`
Update docs/README.md: add TOC / doc descriptions. 2014-12-15 13:43:17 -05:00
Move diagrams out of top-level docs/ directory and merge docs/devel/developer-guide.md into docs/devel/README.md 2015-07-15 02:56:51 -04:00			`* The [Developer guide](devel/README.md) is for anyone wanting to write`
Fix capitalization of Kubernetes in the documentation. 2015-07-20 16:45:36 -04:00			`programs that access the Kubernetes API, write plugins or extensions, or`
			`modify the core code of Kubernetes.`
Update docs/README.md: add TOC / doc descriptions. 2014-12-15 13:43:17 -05:00
fix mungedoc links 2015-07-13 13:32:55 -04:00			`* The [Kubectl Command Line Interface](user-guide/kubectl/kubectl.md) is a detailed reference on`
reflow lines 2015-07-07 18:41:43 -04:00			the `kubectl` CLI.
Update docs/README.md: add TOC / doc descriptions. 2014-12-15 13:43:17 -05:00
Add a README for api-reference docs and link to it instead of linking to swagger-ui 2016-03-16 18:17:03 -04:00			`* The [API object documentation](api-reference/README.md)`
reflow lines 2015-07-07 18:41:43 -04:00			`is a detailed description of all fields found in core API objects.`
Update docs/README.md: add TOC / doc descriptions. 2014-12-15 13:43:17 -05:00
Auto-fixed docs 2015-07-09 21:02:10 -04:00			`* An overview of the [Design of Kubernetes](design/)`
Update docs/README.md: add TOC / doc descriptions. 2014-12-15 13:43:17 -05:00
Auto-fixed docs 2015-07-09 21:02:10 -04:00			`* There are example files and walkthroughs in the [examples](../examples/)`
reflow lines 2015-07-07 18:41:43 -04:00			`folder.`
Add ga-beacon analytics to gendocs scripts hack/run-gendocs.sh puts ga-beacon analytics link into all md files, hack/verify-gendocs.sh verifies presence of link. 2015-05-14 18:12:45 -04:00
fix munge-docs build errors 2016-11-17 10:49:00 -05:00			`* If something went wrong, see the [troubleshooting](http://kubernetes.io/docs/troubleshooting/) guide for how to debug.`
Update references for known issues back to CHANGELOG.md (release notes). 2016-03-24 18:27:54 -04:00			`You should also check the [known issues for the release](../CHANGELOG.md) you're using.`
Organize troubleshooting sections 2015-07-15 13:03:43 -04:00
Vulnerability reporting doc. 2015-07-23 19:15:04 -04:00			`* To report a security issue, see [Reporting a Security Issue](reporting-security-issues.md).`

Add ga-beacon analytics to gendocs scripts hack/run-gendocs.sh puts ga-beacon analytics link into all md files, hack/verify-gendocs.sh verifies presence of link. 2015-05-14 18:12:45 -04:00
Apply mungedocs changes 2015-07-13 20:13:09 -04:00			`<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->`
Add ga-beacon analytics to gendocs scripts hack/run-gendocs.sh puts ga-beacon analytics link into all md files, hack/verify-gendocs.sh verifies presence of link. 2015-05-14 18:12:45 -04:00			`[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/README.md?pixel)]()`
Apply mungedocs changes 2015-07-13 20:13:09 -04:00			`<!-- END MUNGE: GENERATED_ANALYTICS -->`