26149bd83d
Right now, our doc generation scripts notice if you make changes and don't regen docs, don't include new docs, etc. But they miss it if your changes should have REMOVED a doc. Both kubectl-apiversion and kubectl-clusterinfo should have been removed, but weren't. This patch starts tracking all generated doc files and will cause problems if files should be removed and aren't. |
||
|---|---|---|
| .. | ||
| man1 | ||
| Dockerfile | ||
| kube-apiserver.1.md | ||
| kube-controller-manager.1.md | ||
| kube-proxy.1.md | ||
| kube-scheduler.1.md | ||
| kubelet.1.md | ||
| md2man-all.sh | ||
| README.md | ||
Kubernetes Documentation
This directory contains the Kubernetes user manual in the Markdown format. Do not edit the man pages in the man1 directory. Instead, amend the Markdown (*.md) files.
File List
kube-apiserver.1.md
kube-controller-manager.1.md
kubelet.1.md
kube-proxy.1.md
kube-scheduler.1.md
Dockerfile
md2man-all.sh
Generating man pages from the Markdown files
The recommended approach for generating the man pages is via a Docker
container using the supplied Dockerfile to create an image with the correct
environment. This uses go-md2man, a pure Go Markdown to man page generator.
Building the md2man image
There is a Dockerfile provided in the kubernetes/docs/man directory.
Using this Dockerfile, create a Docker image tagged docker/md2man:
docker build -t docker/md2man .
Utilizing the image
Once the image is built, run a container using the image with volumes:
docker run -v /<path-to-git-dir>/kubernetes/docs/man:/docs:rw \
-w /docs -i docker/md2man /docs/md2man-all.sh
The md2man Docker container will process the Markdown files and generate
the man pages inside the docker/docs/man/man1 directory using
Docker volumes. For more information on Docker volumes see the man page for
docker run and also look at the article [Sharing Directories via Volumes]
(http://docs.docker.com/use/working_with_volumes/).