Updating with man pages for distribution

Went through the man pages to update for the v2 instance. Checked against the commands. Signed-off-by: Mary Anthony <mary@docker.com> (cherry picked from commit b6d55eb)
StarGate01 · Apr 16, 2015 · 6410c3c · 6410c3c
1 parent 9231dc9
commit 6410c3c
Show file tree

Hide file tree

Showing 9 changed files with 78 additions and 46 deletions.
diff --git a/docs/Dockerfile b/docs/Dockerfile
@@ -8,7 +8,7 @@ MAINTAINER Sven Dowideit <SvenDowideit@docker.com> (@SvenDowideit)
 COPY . /src
 
 # Reset the /docs dir so we can replace the theme meta with the new repo's git info
-RUN git reset --hard
+# RUN git reset --hard
 
 # Then copy the desired docs into the /docs/sources/ dir
 COPY ./sources/ /docs/sources
@@ -23,6 +23,20 @@ COPY ./mkdocs.yml mkdocs.yml
 COPY ./s3_website.json s3_website.json
 COPY ./release.sh release.sh
 
+
+# Docker Distribution
+#ADD https://raw.githubusercontent.com/moxiegirl/distribution/doc-tooling-changes/docs/mkdocs.yml /docs/mkdocs-distribution.yml
+
+ADD https://raw.githubusercontent.com/moxiegirl/distribution/doc-tooling-changes/docs/overview.md /docs/sources/distribution/overview.md
+RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/distribution/overview.md
+
+ADD https://raw.githubusercontent.com/moxiegirl/distribution/doc-tooling-changes/docs/install.md /docs/sources/distribution/install.md
+RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/distribution/install.md
+
+ADD https://raw.githubusercontent.com/moxiegirl/distribution/doc-tooling-changes/docs/architecture.md /docs/sources/distribution/architecture.md
+RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/distribution/architecture.md
+
+
 # Docker Swarm
 #ADD https://raw.githubusercontent.com/docker/swarm/master/docs/mkdocs.yml /docs/mkdocs-swarm.yml
 ADD https://raw.githubusercontent.com/docker/swarm/master/docs/index.md /docs/sources/swarm/index.md

diff --git a/docs/man/docker-login.1.md b/docs/man/docker-login.1.md
@@ -2,7 +2,7 @@
 % Docker Community
 % JUNE 2014
 # NAME
-docker-login - Register or log in to a Docker registry server, if no server is specified "https://index.docker.io/v1/" is the default.
+docker-login - Register or log in to a Docker registry. 
 
 # SYNOPSIS
 **docker login**
@@ -13,9 +13,14 @@ docker-login - Register or log in to a Docker registry server, if no server is s
 [SERVER]
 
 # DESCRIPTION
-Register or Login to a docker registry server, if no server is
-specified "https://index.docker.io/v1/" is the default. If you want to
-login to a private registry you can specify this by adding the server name.
+Register or log in to a Docker Registry Service located on the specified
+`SERVER`.  You can specify a URL or a `hostname` for the `SERVER` value. If you
+do not specify a `SERVER`, the command uses Docker's public registry located at
+`https://registry-1.docker.io/` by default.  To get a username/password for Docker's public registry, create an account on Docker Hub.
+
+You can log into any public or private repository for which you have
+credentials.  When you log in, the command stores encoded credentials in
+`$HOME/.dockercfg` on Linux or `%USERPROFILE%/.dockercfg` on Windows.
 
 # OPTIONS
 **-e**, **--email**=""
@@ -32,7 +37,7 @@ login to a private registry you can specify this by adding the server name.
 
 # EXAMPLES
 
-## Login to a local registry
+## Login to a registry on your localhost
 
     # docker login localhost:8080
 
@@ -43,3 +48,4 @@ login to a private registry you can specify this by adding the server name.
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
 based on docker.com source material and internal work.
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
diff --git a/docs/man/docker-logout.1.md b/docs/man/docker-logout.1.md
@@ -2,23 +2,24 @@
 % Docker Community
 % JUNE 2014
 # NAME
-docker-logout - Log out from a Docker registry, if no server is specified "https://index.docker.io/v1/" is the default.
+docker-logout - Log out from a Docker Registry Service.
 
 # SYNOPSIS
 **docker logout**
 [SERVER]
 
 # DESCRIPTION
-Log the user out from a Docker registry, if no server is
-specified "https://index.docker.io/v1/" is the default. If you want to
-log out from a private registry you can specify this by adding the server name.
+Log out of a Docker Registry Service located on the specified `SERVER`. You can
+specify a URL or a `hostname` for the `SERVER` value. If you do not specify a
+`SERVER`, the command attempts to log you out of Docker's public registry
+located at `https://registry-1.docker.io/` by default.  
 
 # OPTIONS
 There are no available options.
 
 # EXAMPLES
 
-## Log out from a local registry
+## Log out from a registry on your localhost
 
     # docker logout localhost:8080
 
@@ -28,3 +29,4 @@ There are no available options.
 # HISTORY
 June 2014, Originally compiled by Daniel, Dao Quang Minh (daniel at nitrous dot io)
 July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
diff --git a/docs/man/docker-pull.1.md b/docs/man/docker-pull.1.md
@@ -2,7 +2,7 @@
 % Docker Community
 % JUNE 2014
 # NAME
-docker-pull - Pull an image or a repository from the registry
+docker-pull - Pull an image or a repository from a registry
 
 # SYNOPSIS
 **docker pull**
@@ -12,10 +12,12 @@ NAME[:TAG]
 
 # DESCRIPTION
 
-This command pulls down an image or a repository from the registry. If
+This command pulls down an image or a repository from a registry. If
 there is more than one image for a repository (e.g., fedora) then all
 images for that repository name are pulled down including any tags.
-It is also possible to specify a non-default registry to pull from.
+
+If you do not specify a `REGISTRY_HOST`, the command uses Docker's public
+registry located at `registry-1.docker.io` by default. 
 
 # OPTIONS
 **-a**, **--all-tags**=*true*|*false*
@@ -45,7 +47,7 @@ It is also possible to specify a non-default registry to pull from.
     fedora       heisenbug   105182bb5e8b    5 days ago   372.7 MB
     fedora       latest      105182bb5e8b    5 days ago   372.7 MB
 
-# Pull an image, manually specifying path to the registry and tag
+# Pull an image, manually specifying path to Docker's public registry and tag
 # Note that if the  image is previously downloaded then the status would be
 # 'Status: Image is up to date for registry.hub.docker.com/fedora:20'
 
@@ -67,3 +69,5 @@ April 2014, Originally compiled by William Henry (whenry at redhat dot com)
 based on docker.com source material and internal work.
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
 August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+April 2015, updated by John Willis <john.willis@docker.com>
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
diff --git a/docs/man/docker-push.1.md b/docs/man/docker-push.1.md
@@ -2,18 +2,18 @@
 % Docker Community
 % JUNE 2014
 # NAME
-docker-push - Push an image or a repository to the registry
+docker-push - Push an image or a repository to a registry
 
 # SYNOPSIS
 **docker push**
 [**--help**]
-NAME[:TAG]
+NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG]
 
 # DESCRIPTION
-Push an image or a repository to a registry. The default registry is the Docker 
-Hub located at [hub.docker.com](https://hub.docker.com/). However the 
-image can be pushed to another, perhaps private, registry as demonstrated in 
-the example below.
+
+This command pushes an image or a repository to a registry. If you do not
+specify a `REGISTRY_HOST`, the command uses Docker's public registry located at
+`registry-1.docker.io` by default. 
 
 # OPTIONS
 **--help**
@@ -28,12 +28,10 @@ and then committing it to a new image name:
 
     # docker commit c16378f943fe rhel-httpd
 
-Now push the image to the registry using the image ID. In this example
-the registry is on host named registry-host and listening on port 5000.
-Default Docker commands will push to the default `hub.docker.com`
-registry. Instead, push to the local registry, which is on a host called
-registry-host*. To do this, tag the image with the host name or IP
-address, and the port of the registry:
+Now, push the image to the registry using the image ID. In this example the
+registry is on host named `registry-host` and listening on port `5000`. To do
+this, tag the image with the host name or IP address, and the port of the
+registry:
 
     # docker tag rhel-httpd registry-host:5000/myadmin/rhel-httpd
     # docker push registry-host:5000/myadmin/rhel-httpd
@@ -49,3 +47,5 @@ listed.
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
 based on docker.com source material and internal work.
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
+
diff --git a/docs/man/docker-rmi.1.md b/docs/man/docker-rmi.1.md
@@ -13,10 +13,9 @@ IMAGE [IMAGE...]
 
 # DESCRIPTION
 
-This will remove one or more images from the host node. This does not
-remove images from a registry. You cannot remove an image of a running
-container unless you use the **-f** option. To see all images on a host
-use the **docker images** command.
+Removes one or more images from the host node. This does not remove images from
+a registry. You cannot remove an image of a running container unless you use the
+**-f** option. To see all images on a host use the **docker images** command.
 
 # OPTIONS
 **-f**, **--force**=*true*|*false*
@@ -40,3 +39,4 @@ Here is an example of removing and image:
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
 based on docker.com source material and internal work.
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
diff --git a/docs/man/docker-search.1.md b/docs/man/docker-search.1.md
@@ -14,10 +14,9 @@ TERM
 
 # DESCRIPTION
 
-Search an index for an image with that matches the term TERM. The table
-of images returned displays the name, description (truncated by default),
-number of stars awarded, whether the image is official, and whether it
-is automated.
+Search Docker Hub for an image with that matches the specified `TERM`. The table
+of images returned displays the name, description (truncated by default), number
+of stars awarded, whether the image is official, and whether it is automated.
 
 *Note* - Search queries will only return up to 25 results
 
@@ -36,9 +35,9 @@ is automated.
 
 # EXAMPLES
 
-## Search the registry for ranked images
+## Search Docker Hub for ranked images
 
-Search the registry for the term 'fedora' and only display those images
+Search a registry for the term 'fedora' and only display those images
 ranked 3 or higher:
 
     $ sudo docker search -s 3 fedora
@@ -48,9 +47,9 @@ ranked 3 or higher:
     mattdm/fedora-small   A small Fedora image on which to build. Co...  8
     goldmann/wildfly      A WildFly application server running on a ...  3               [OK]
 
-## Search the registry for automated images
+## Search Docker Hub for automated images
 
-Search the registry for the term 'fedora' and only display automated images
+Search Docker Hub for the term 'fedora' and only display automated images
 ranked 1 or higher:
 
     $ sudo docker search -s 1 -t fedora
@@ -62,3 +61,5 @@ ranked 1 or higher:
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
 based on docker.com source material and internal work.
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
+
diff --git a/docs/man/docker-tag.1.md b/docs/man/docker-tag.1.md
@@ -8,11 +8,14 @@ docker-tag - Tag an image into a repository
 **docker tag**
 [**-f**|**--force**[=*false*]]
 [**--help**]
-IMAGE[:TAG] [REGISTRYHOST/][USERNAME/]NAME[:TAG]
+IMAGE[:TAG] [REGISTRY_HOST/][USERNAME/]NAME[:TAG]
 
 # DESCRIPTION
-This will give a new alias to an image in the repository. This refers to the
-entire image name including the optional TAG after the ':'. 
+Assigns a new alias to an image in a registry. An alias refers to the
+entire image name including the optional `TAG` after the ':'. 
+
+If you do not specify a `REGISTRY_HOST`, the command uses Docker's public
+registry located at `registry-1.docker.io` by default. 
 
 # "OPTIONS"
 **-f**, **--force**=*true*|*false*
@@ -58,3 +61,5 @@ April 2014, Originally compiled by William Henry (whenry at redhat dot com)
 based on docker.com source material and internal work.
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
 July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
+
diff --git a/docs/man/docker.1.md b/docs/man/docker.1.md
@@ -172,10 +172,10 @@ inside it)
   Load an image from a tar archive
 
 **docker-login(1)**
-  Register or Login to a Docker registry server
+  Register or login to a Docker Registry Service
 
 **docker-logout(1)**
-  Log the user out of a Docker registry server
+  Log the user out of a Docker Registry Service
 
 **docker-logs(1)**
   Fetch the logs of a container
@@ -190,10 +190,10 @@ inside it)
   List containers
 
 **docker-pull(1)**
-  Pull an image or a repository from a Docker registry server
+  Pull an image or a repository from a Docker Registry Service
 
 **docker-push(1)**
-  Push an image or a repository to a Docker registry server
+  Push an image or a repository to a Docker Registry Service
 
 **docker-restart(1)**
   Restart a running container