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

17 lines
848 B
Markdown
Raw Normal View History

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
# Kubernetes Documentation
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
* The [User's guide](user-guide.md) is for anyone who wants to run programs and services on an exisiting Kubernetes cluster.
Update docs/README.md: add TOC / doc descriptions.
2014-12-15 18:43:17 +00:00
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
* The [Cluster Admin's guide](cluster-admin-guide.md) is for anyone setting up a Kubernetes cluster or administering it.
Update docs/README.md: add TOC / doc descriptions.
2014-12-15 18:43:17 +00:00
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
* The [Developer guide](developer-guide.md) is for anyone wanting to write 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 link to kubectl docs in docs/README.md
2015-03-15 16:48:04 +00:00
* The [Kubectl Command Line Interface](kubectl.md) is a detailed reference on the `kubectl` CLI.
Update docs/README.md: add TOC / doc descriptions.
2014-12-15 18:43:17 +00:00
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +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
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
* An overview of the [Design of Kubernetes](../DESIGN.md)
Update docs/README.md: add TOC / doc descriptions.
2014-12-15 18:43:17 +00:00
User, Admin, and Developer guides. First pass at organizing our docs for three separate audiences: User, Cluster Admin, and developer. Wrote a top-level guide for each one, by selecting parts of the old docs/README.md. The new docs/README.md mostly points to these 3 guides.
2015-03-10 21:27:10 +00:00
* There are example files and walkthroughs in the [examples](../examples) folder.