github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs/README.md

66 lines
2.3 KiB
Markdown
Raw Normal View History

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
Better scary message
2015-07-16 17:02:26 +00:00
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
If you are using a released version of Kubernetes, you should
refer to the docs that go with that version.
<strong>
The latest 1.0.x release of this document can be found
[here](http://releases.k8s.io/release-1.0/docs/README.md).
Documentation for other releases can be found at
[releases.k8s.io](http://releases.k8s.io).
</strong>
--
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 -->
Run gendocs
2015-07-17 22:35:41 +00:00
Run gendocs and munges
2015-07-12 04:04:52 +00: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 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
Fix capitalization of Kubernetes in the documentation.
2015-07-20 20:45:36 +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 a known issues doc.
2015-07-20 23:32:40 +00:00
You should also check the [known issues](user-guide/known-issues.md) for the release you're using.
Organize troubleshooting sections
2015-07-15 17:03:43 +00:00
Vulnerability reporting doc.
2015-07-23 23:15:04 +00: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 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 -->