k3s/docs/README.md

<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->

<!-- BEGIN STRIP_FOR_RELEASE -->

![WARNING](http://kubernetes.io/img/warning.png)
![WARNING](http://kubernetes.io/img/warning.png)
![WARNING](http://kubernetes.io/img/warning.png)

<h1>PLEASE NOTE: This document applies to the HEAD of the source
tree only. If you are using a released version of Kubernetes, you almost
certainly want the docs that go with that version.</h1>

<strong>Documentation for specific releases can be found at
[releases.k8s.io](http://releases.k8s.io).</strong>

![WARNING](http://kubernetes.io/img/warning.png)
![WARNING](http://kubernetes.io/img/warning.png)
![WARNING](http://kubernetes.io/img/warning.png)

<!-- END STRIP_FOR_RELEASE -->

<!-- END MUNGE: UNVERSIONED_WARNING -->
# 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](http://kubernetes.io/third_party/swagger-ui/)
  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](troubleshooting.md) document for how to debug.


<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/README.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS -->
Run gendocs and munges 2015-07-12 04:04:52 +00:00			`<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->`
Separated user, dev, and design docs. Renamed: logging.md -> devel/logging.m Renamed: access.md -> design/access.md Renamed: identifiers.md -> design/identifiers.md Renamed: labels.md -> design/labels.md Renamed: namespaces.md -> design/namespaces.md Renamed: security.md -> design/security.md Renamed: networking.md -> design/networking.md Added abbreviated user user-focused document in place of most moved docs. Added docs/README.md explains how docs are organized. Added short, user-oriented documentation on labels Added a glossary. Fixed up some links. 2014-10-16 21:45:16 +00:00
Make READMEs clearer wrt versions 2015-07-07 23:22:34 +00:00			`<!-- BEGIN STRIP_FOR_RELEASE -->`
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 04:18:30 +00:00
Run gendocs 2015-07-15 00:28:47 +00:00			`![WARNING](http://kubernetes.io/img/warning.png)`
			`![WARNING](http://kubernetes.io/img/warning.png)`
			`![WARNING](http://kubernetes.io/img/warning.png)`
Run gendocs 2015-07-13 22:15:35 +00:00
			`<h1>PLEASE NOTE: This document applies to the HEAD of the source`
Make READMEs clearer wrt versions 2015-07-07 23:22:34 +00:00			`tree only. If you are using a released version of Kubernetes, you almost`
			`certainly want the docs that go with that version.</h1>`

			`<strong>Documentation for specific releases can be found at`
			`[releases.k8s.io](http://releases.k8s.io).</strong>`

Run gendocs 2015-07-15 00:28:47 +00:00			`![WARNING](http://kubernetes.io/img/warning.png)`
			`![WARNING](http://kubernetes.io/img/warning.png)`
			`![WARNING](http://kubernetes.io/img/warning.png)`
Run gendocs 2015-07-13 22:15:35 +00:00
Make READMEs clearer wrt versions 2015-07-07 23:22:34 +00:00			`<!-- END STRIP_FOR_RELEASE -->`

Run gendocs and munges 2015-07-12 04:04:52 +00:00			`<!-- END MUNGE: UNVERSIONED_WARNING -->`
			`# 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 04:18:30 +00:00
Initial TOC for the user guide. 2015-07-14 17:24:12 +00:00			`* The [User's guide](user-guide/README.md) is for anyone who wants to run programs and`
reflow lines 2015-07-07 22:41:43 +00:00			`services on an existing Kubernetes cluster.`
Update docs/README.md: add TOC / doc descriptions. 2014-12-15 18:43:17 +00:00
move admin related docs into docs/admin 2015-07-09 20:33:48 +00:00			`* The [Cluster Admin's guide](admin/README.md) is for anyone setting up`
reflow lines 2015-07-07 22:41:43 +00:00			`a Kubernetes cluster or administering it.`
Update docs/README.md: add TOC / doc descriptions. 2014-12-15 18:43:17 +00:00
Move diagrams out of top-level docs/ directory and merge docs/devel/developer-guide.md into docs/devel/README.md 2015-07-15 06:56:51 +00:00			`* The [Developer guide](devel/README.md) is for anyone wanting to write`
reflow lines 2015-07-07 22:41:43 +00: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 18:43:17 +00:00
fix mungedoc links 2015-07-13 17:32:55 +00:00			`* The [Kubectl Command Line Interface](user-guide/kubectl/kubectl.md) is a detailed reference on`
reflow lines 2015-07-07 22:41:43 +00:00			the `kubectl` CLI.
Update docs/README.md: add TOC / doc descriptions. 2014-12-15 18:43:17 +00:00
reflow lines 2015-07-07 22:41:43 +00:00			`* The [API object documentation](http://kubernetes.io/third_party/swagger-ui/)`
			`is a detailed description of all fields found in core API objects.`
Update docs/README.md: add TOC / doc descriptions. 2014-12-15 18:43:17 +00:00
Auto-fixed docs 2015-07-10 01:02:10 +00:00			`* An overview of the [Design of Kubernetes](design/)`
Update docs/README.md: add TOC / doc descriptions. 2014-12-15 18:43:17 +00:00
Auto-fixed docs 2015-07-10 01:02:10 +00:00			`* There are example files and walkthroughs in the [examples](../examples/)`
reflow lines 2015-07-07 22:41:43 +00: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 22:12:45 +00:00
Organize troubleshooting sections 2015-07-15 17:03:43 +00:00			`* If something went wrong, see the [troubleshooting](troubleshooting.md) document for how to debug.`

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 22:12:45 +00:00
Apply mungedocs changes 2015-07-14 00:13:09 +00: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 22:12:45 +00:00			`[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/README.md?pixel)]()`
Apply mungedocs changes 2015-07-14 00:13:09 +00:00			`<!-- END MUNGE: GENERATED_ANALYTICS -->`