ff6d67e18c
These docs are not autogenerated. They are generated from specially formated markdown files that need to be updated when flags are changed but nobody knows about this so it is not enforced. Thus the man page generation is not useful. For the sake of having up to date docs up to date for v1, I am manually udating the markdown files and removing the md2man generation. After v1 we need to gen this man pages with the rest of our generated docs in a pre commit hook so that they are not able to become out of date. We can do this by converting our daemons to use cobra cmd like kubectl.
Kubernetes Documentation
Note This documentation is current for HEAD.
Documentation for previous releases is available in their respective branches:
-
The User's guide is for anyone who wants to run programs and services on an existing Kubernetes cluster.
-
The Cluster Admin's guide is for anyone setting up a Kubernetes cluster or administering it.
-
The Developer guide 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 is a detailed reference on the
kubectlCLI. -
The API object documentation is a detailed description of all fields found in core API objects.
-
An overview of the Design of Kubernetes
-
There are example files and walkthroughs in the examples folder.