docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #14161 from laijs/man_pages 

man: convert `docker/docs/man` to `docker/man`
This commit is contained in:
moxiegirl 2015-06-25 13:12:46 -07:00
parent 8c8e8d624f 85e2957409
commit 15d8e7bc6b
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
man/README.md
View File

@ -13,7 +13,7 @@ environment. This uses `go-md2man`, a pure Go Markdown to man page generator.
## Building the md2man image ## Building the md2man image
There is a `Dockerfile` provided in the `docker/docs/man` directory. There is a `Dockerfile` provided in the `docker/man` directory.
Using this `Dockerfile`, create a Docker image tagged `docker/md2man`: Using this `Dockerfile`, create a Docker image tagged `docker/md2man`:
@ -23,11 +23,11 @@ Using this `Dockerfile`, create a Docker image tagged `docker/md2man`:
Once the image is built, run a container using the image with *volumes*: 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 \ docker run -v /<path-to-git-dir>/docker/man:/docs:rw \
-w /docs -i docker/md2man /docs/md2man-all.sh -w /docs -i docker/md2man /docs/md2man-all.sh
The `md2man` Docker container will process the Markdown files and generate The `md2man` Docker container will process the Markdown files and generate
the man pages inside the `docker/docs/man/man1` directory using the man pages inside the `docker/man/man1` directory using
Docker volumes. For more information on Docker volumes see the man page for 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] `docker run` and also look at the article [Sharing Directories via Volumes]
(https://docs.docker.com/use/working_with_volumes/). (https://docs.docker.com/use/working_with_volumes/).