1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00

Further edtis based on comments.

Docker-DCO-1.1-Signed-off-by: William Henry <whenry@redhat.com> (github: ipbabble)

 Changes to be committed:
	modified:   contrib/man/md/README.md
	modified:   contrib/man/md/docker-build.md
	modified:   contrib/man/md/docker-cp.md
	modified:   contrib/man/md/docker-logs.md
	modified:   contrib/man/md/docker-push.md
This commit is contained in:
William Henry 2014-04-21 14:28:25 -06:00
parent bbde4298a5
commit 73257a72ea
5 changed files with 16 additions and 12 deletions

View file

@ -44,12 +44,12 @@ Markdown (*.md) files.
# Generating man pages from the Markdown files # Generating man pages from the Markdown files
The recommended approach for generating the man pages using a Docker container The recommended approach for generating the man pages is via a Docker
one. Using the supplied Dockerfile, Docker creates a Fedora based container container. Using the supplied Dockerfile, Docker will create a Fedora based
and isolates the Pandoc installation. This is a seamless process, saving you container and isolate the Pandoc installation. This is a seamless process,
from dealing with Pandoc and dependencies on your own computer. saving you from dealing with Pandoc and dependencies on your own computer.
## Using the pandoc Container ## Building the Fedora / Pandoc Image
There is a Dockerfile provided in the `docker/contrib/man/md` directory. There is a Dockerfile provided in the `docker/contrib/man/md` directory.
@ -57,6 +57,8 @@ Using this Dockerfile, create a Docker image tagged `fedora/pandoc`:
docker build -t fedora/pandoc . docker build -t fedora/pandoc .
## Utilizing the Fedora / Pandoc image
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/contrib/man:/pandoc:rw \ docker run -v /<path-to-git-dir>/docker/contrib/man:/pandoc:rw \
@ -65,5 +67,5 @@ Once the image is built, run a container using the image with *volumes*:
The Pandoc Docker container will process the Markdown files and generate The Pandoc Docker container will process the Markdown files and generate
the man pages inside the `docker/contrib/man/man1` directory using the man pages inside the `docker/contrib/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 [Shared Directories via Volumes] `docker run` and also look at the article [Sharing Directories via Volumes]
(http://docs.docker.io/use/working_with_volumes/). (http://docs.docker.io/use/working_with_volumes/).

View file

@ -15,7 +15,7 @@ directory to the Docker daemon. The contents of this directory would
be used by **ADD** commands found within the Dockerfile. be used by **ADD** commands found within the Dockerfile.
Warning, this will send a lot of data to the Docker daemon depending Warning, this will send a lot of data to the Docker daemon depending
on the contents of the current directory. he build is run by the Docker on the contents of the current directory. The build is run by the Docker
daemon, not by the CLI, so the whole context must be transferred to the daemon. daemon, not by the CLI, so the whole context must be transferred to the daemon.
The Docker CLI reports "Uploading context" when the context is sent to The Docker CLI reports "Uploading context" when the context is sent to
the daemon. the daemon.

View file

@ -9,8 +9,8 @@ docker-cp - Copy files/folders from the PATH to the HOSTPATH
# DESCRIPTION # DESCRIPTION
Copy files/folders from the containers filesystem to the host Copy files/folders from the containers filesystem to the host
path. Paths are relative to the root of the filesystem. Files path. Paths are relative to the root of the filesystem. Files
can be copied from a running or stopped containers can be copied from a running or stopped container.
# EXAMPLE # EXAMPLE
An important shell script file, created in a bash shell, is copied from An important shell script file, created in a bash shell, is copied from

View file

@ -14,7 +14,7 @@ order when combined with a docker run (i.e. your run may not have generated
any logs at the time you execute docker logs). any logs at the time you execute docker logs).
The **docker logs --follow** command combines commands **docker logs** and The **docker logs --follow** command combines commands **docker logs** and
**docker attach**. It will first return all logs from the beginning and **docker attach**. It will first return all logs from the beginning and
then continue streaming new output from the containers stdout and stderr. then continue streaming new output from the containers stdout and stderr.
# OPTIONS # OPTIONS

View file

@ -8,8 +8,10 @@ docker-push - Push an image or a repository to the registry
**docker push** NAME[:TAG] **docker push** NAME[:TAG]
# DESCRIPTION # DESCRIPTION
Push and image or repository to a registry. The registry may the default Push an image or a repository to a registry. The default registry is the Docker
[index.docker.io](https://index.docker.io/v1/) or a another registry Index located at [index.docker.io](https://index.docker.io/v1/). However the
image can be pushed to another, perhaps private, registry as demonstrated in
the example below.
# EXAMPLE # EXAMPLE