eacae64b |
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.
|
f93fee5f |
## Building the md2man image |
eacae64b |
|
96699e06 |
There is a `Dockerfile` provided in the `/man` directory of your
'docker/docker' fork. |
eacae64b |
|
f93fee5f |
Using this `Dockerfile`, create a Docker image tagged `docker/md2man`: |
eacae64b |
|
f93fee5f |
docker build -t docker/md2man . |
eacae64b |
|
f93fee5f |
## Utilizing the image |
eacae64b |
|
96699e06 |
From within the `/man` directory run the following command: |
eacae64b |
|
96699e06 |
docker run -v $(pwd):/man -w /man -i docker/md2man ./md2man-all.sh
|
f93fee5f |
The `md2man` Docker container will process the Markdown files and generate |
96699e06 |
the man pages inside the `/man/man1` directory of your fork using |
f93fee5f |
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]
(https://docs.docker.com/use/working_with_volumes/). |