mirror of https://github.com/docker/cli.git
retooling for hugo
Tweaking for Hugo Updating the Dockerfile with new sed; fix broken link on Kitematic Fixing image pull for Dockerfile Removing docs targets Signed-off-by: Mary Anthony <mary@docker.com>
This commit is contained in:
parent
bd7b88932c
commit
d1d033701e
|
@ -1,3 +1,9 @@
|
||||||
|
<!--[metadata]>
|
||||||
|
+++
|
||||||
|
draft = true
|
||||||
|
+++
|
||||||
|
<![end-metadata]-->
|
||||||
|
|
||||||
# Docker Documentation
|
# Docker Documentation
|
||||||
|
|
||||||
The source for Docker documentation is in this directory under `sources/`. Our
|
The source for Docker documentation is in this directory under `sources/`. Our
|
||||||
|
|
|
@ -1,6 +1,12 @@
|
||||||
page_title: Dockerfile reference
|
<!--[metadata]>
|
||||||
page_description: Dockerfiles use a simple DSL which allows you to automate the steps you would normally manually take to create an image.
|
+++
|
||||||
page_keywords: builder, docker, Dockerfile, automation, image creation
|
title = "Dockerfile reference"
|
||||||
|
description = "Dockerfiles use a simple DSL which allows you to automate the steps you would normally manually take to create an image."
|
||||||
|
keywords = ["builder, docker, Dockerfile, automation, image creation"]
|
||||||
|
[menu.main]
|
||||||
|
parent = "mn_reference"
|
||||||
|
+++
|
||||||
|
<![end-metadata]-->
|
||||||
|
|
||||||
# Dockerfile reference
|
# Dockerfile reference
|
||||||
|
|
|
@ -1,6 +1,12 @@
|
||||||
page_title: Command Line Interface
|
<!--[metadata]>
|
||||||
page_description: Docker's CLI command description and usage
|
+++
|
||||||
page_keywords: Docker, Docker documentation, CLI, command line
|
title = "Command Line Interface"
|
||||||
|
description = "Docker's CLI command description and usage"
|
||||||
|
keywords = ["Docker, Docker documentation, CLI, command line"]
|
||||||
|
[menu.main]
|
||||||
|
parent = "mn_reference"
|
||||||
|
+++
|
||||||
|
<![end-metadata]-->
|
||||||
|
|
||||||
# Docker Command Line
|
# Docker Command Line
|
||||||
|
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
|
@ -1,6 +1,13 @@
|
||||||
page_title: Docker Glossary
|
<!--[metadata]>
|
||||||
page_description: Glossary of terms used around Docker
|
+++
|
||||||
page_keywords: glossary, docker, terms, definitions
|
title = "Docker Glossary"
|
||||||
|
description = "Glossary of terms used around Docker"
|
||||||
|
keywords = ["glossary, docker, terms, definitions"]
|
||||||
|
[menu.main]
|
||||||
|
parent = "mn_about"
|
||||||
|
weight = "50"
|
||||||
|
+++
|
||||||
|
<![end-metadata]-->
|
||||||
|
|
||||||
# Glossary
|
# Glossary
|
||||||
|
|
|
@ -1,6 +1,12 @@
|
||||||
page_title: Docker run reference
|
<!--[metadata]>
|
||||||
page_description: Configure containers at runtime
|
+++
|
||||||
page_keywords: docker, run, configure, runtime
|
title = "Docker run reference"
|
||||||
|
description = "Configure containers at runtime"
|
||||||
|
keywords = ["docker, run, configure, runtime"]
|
||||||
|
[menu.main]
|
||||||
|
parent = "mn_reference"
|
||||||
|
+++
|
||||||
|
<![end-metadata]-->
|
||||||
|
|
||||||
<!-- TODO (@thaJeztah) define more flexible table/td classes -->
|
<!-- TODO (@thaJeztah) define more flexible table/td classes -->
|
||||||
<style>
|
<style>
|
|
@ -11,34 +11,23 @@ The recommended approach for generating the man pages is via a Docker
|
||||||
container using the supplied `Dockerfile` to create an image with the correct
|
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.
|
environment. This uses `go-md2man`, a pure Go Markdown to man page generator.
|
||||||
|
|
||||||
### Generate the man pages
|
## Building the md2man image
|
||||||
|
|
||||||
On Linux installations, Docker includes a set of man pages you can access by typing `man command-name` on the command line. For example, `man docker` displays the `docker` man page. When using Docker on Mac OSX the man pages are not automatically included.
|
There is a `Dockerfile` provided in the `docker/docs/man` directory.
|
||||||
|
|
||||||
You can generate and install the `man` pages yourself by following these steps:
|
Using this `Dockerfile`, create a Docker image tagged `docker/md2man`:
|
||||||
|
|
||||||
1. Checkout the `docker` source.
|
docker build -t docker/md2man .
|
||||||
|
|
||||||
$ git clone https://github.com/docker/docker.git
|
## Utilizing the image
|
||||||
|
|
||||||
If you are using Boot2Docker, you must clone into your `/Users` directory
|
|
||||||
because Boot2Docker can only share this path with the docker containers.
|
|
||||||
|
|
||||||
2. Build the docker image.
|
|
||||||
|
|
||||||
$ cd docker/man
|
|
||||||
$ docker build -t docker/md2man .
|
|
||||||
|
|
||||||
3. Build the man pages.
|
|
||||||
|
|
||||||
$ docker run -v <path-to-git-dir>/docker/man:/man:rw -w /man -i docker/md2man /man/md2man-all.sh
|
|
||||||
|
|
||||||
The `md2man` Docker container processes the Markdown files and generates
|
|
||||||
a `man1` and `man5` subdirectories in the `docker/man` directory.
|
|
||||||
|
|
||||||
4. Copy the generated man pages to `/usr/share/man`
|
|
||||||
|
|
||||||
$ cp -R man* /usr/share/man/
|
|
||||||
|
|
||||||
|
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]
|
||||||
|
(https://docs.docker.com/use/working_with_volumes/).
|
||||||
|
|
Loading…
Reference in New Issue