5f00f97ea0
Proposal: One Meta Data to Rule Them All => Labels Upstream-commit: b6ac111abfbed628a80b67f0b092a248083b354c Component: engine
Docker Documentation
This directory contains the Docker user manual in the Markdown format. Do not edit the man pages in the man1 directory. Instead, amend the Markdown (*.md) files.
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 docker/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>/docker/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/).