github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs
History
Eric Tune c47693c0d5 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-31 08:35:53 -07:00
..
design Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
devel Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
getting-started-guides Don't include '.' in release tars. 2014-10-30 10:51:13 -07:00
man remove systemd example files from man pages 2014-10-29 13:42:23 -04:00
README.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
annotations.md Label documentation improvements. Add annotations documentation. 2014-10-15 22:38:00 +00:00
api-conventions.md Proposal for v1beta3 API 2014-09-29 12:10:36 -04:00
architecture.dia First take at architecture diagram. 2014-07-16 14:06:07 -07:00
architecture.png First take at architecture diagram. 2014-07-16 14:06:07 -07:00
architecture.svg First take at architecture diagram. 2014-07-16 14:06:07 -07:00
cli.md Add CLI details to the readme. 2014-07-28 15:46:58 -07:00
client-libraries.md Add documentation for client libraries 2014-09-03 22:21:42 -07:00
container-environment.md Document images. 2014-10-09 13:40:56 -07:00
dns.md rename the nd file 2014-10-16 16:37:47 -04:00
glossary.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
identifiers.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
images.md Document images. 2014-10-09 13:40:56 -07:00
labels.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
logging.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
namespaces.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
networking.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
overview.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
ovs-networking.md ovs networking document 2014-09-08 17:06:25 -07:00
ovs-networking.png ovs networking document 2014-09-08 17:06:25 -07:00
pod-states.md Add a doc on pod states 2014-09-23 08:40:17 -07:00
pods.md Fixes a bad link in pods.md document 2014-10-14 15:45:10 -04:00
replication-controller.md Add documentation of replication controller. 2014-10-01 23:22:10 +00:00
resources.md Initial version of a resource model. 2014-09-01 19:48:00 -07:00
roadmap.md Update roadmap 2014-08-28 12:42:22 -07:00
salt.md Tweak salt docs a little 2014-10-10 12:30:12 -07:00
services.md Add and update docs. 2014-10-16 08:36:47 -07:00
services_detail.png Add and update docs. 2014-10-16 08:36:47 -07:00
services_detail.svg Add and update docs. 2014-10-16 08:36:47 -07:00
services_overview.png Add and update docs. 2014-10-16 08:36:47 -07:00
services_overview.svg Add and update docs. 2014-10-16 08:36:47 -07:00
ux.md Separated user, dev, and design docs. 2014-10-31 08:35:53 -07:00
volumes.md Document media, resource limits for volumes. 2014-10-10 08:12:56 -07:00

README.md

Kubernetes Documentation

Kubernetes documentation is organized into several categories.

  • Getting Started Guides
  • User Documentation
    • in docs
    • 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
    • for people who want to contribute code to kubernetes
    • covers development conventions
    • explains current architecture and project plans
  • Design Documentation
    • in docs/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
    • Hands on introduction and example config files
  • API documentation
    • in api
    • automatically generated REST API documentation
  • Wiki