Browse code

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>

Mary Anthony authored on 2015/04/02 04:20:59
Showing 9 changed files
... ...
@@ -8,7 +8,7 @@ MAINTAINER Sven Dowideit <SvenDowideit@docker.com> (@SvenDowideit)
8 8
 COPY . /src
9 9
 
10 10
 # Reset the /docs dir so we can replace the theme meta with the new repo's git info
11
-RUN git reset --hard
11
+# RUN git reset --hard
12 12
 
13 13
 # Then copy the desired docs into the /docs/sources/ dir
14 14
 COPY ./sources/ /docs/sources
... ...
@@ -23,6 +23,20 @@ COPY ./mkdocs.yml mkdocs.yml
23 23
 COPY ./s3_website.json s3_website.json
24 24
 COPY ./release.sh release.sh
25 25
 
26
+
27
+# Docker Distribution
28
+#ADD https://raw.githubusercontent.com/moxiegirl/distribution/doc-tooling-changes/docs/mkdocs.yml /docs/mkdocs-distribution.yml
29
+
30
+ADD https://raw.githubusercontent.com/moxiegirl/distribution/doc-tooling-changes/docs/overview.md /docs/sources/distribution/overview.md
31
+RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/distribution/overview.md
32
+
33
+ADD https://raw.githubusercontent.com/moxiegirl/distribution/doc-tooling-changes/docs/install.md /docs/sources/distribution/install.md
34
+RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/distribution/install.md
35
+
36
+ADD https://raw.githubusercontent.com/moxiegirl/distribution/doc-tooling-changes/docs/architecture.md /docs/sources/distribution/architecture.md
37
+RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/distribution/architecture.md
38
+
39
+
26 40
 # Docker Swarm
27 41
 #ADD https://raw.githubusercontent.com/docker/swarm/master/docs/mkdocs.yml /docs/mkdocs-swarm.yml
28 42
 ADD https://raw.githubusercontent.com/docker/swarm/master/docs/index.md /docs/sources/swarm/index.md
... ...
@@ -2,7 +2,7 @@
2 2
 % Docker Community
3 3
 % JUNE 2014
4 4
 # NAME
5
-docker-login - Register or log in to a Docker registry server, if no server is specified "https://index.docker.io/v1/" is the default.
5
+docker-login - Register or log in to a Docker registry. 
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker login**
... ...
@@ -13,12 +13,14 @@ docker-login - Register or log in to a Docker registry server, if no server is s
13 13
 [SERVER]
14 14
 
15 15
 # DESCRIPTION
16
-Register or Login to a docker registry server, if no server is
17
-specified "https://index.docker.io/v1/" is the default. If you want to
18
-login to a private registry you can specify this by adding the server name.
16
+Register or log in to a Docker Registry Service located on the specified
17
+`SERVER`.  You can specify a URL or a `hostname` for the `SERVER` value. If you
18
+do not specify a `SERVER`, the command uses Docker's public registry located at
19
+`https://registry-1.docker.io/` by default.  To get a username/password for Docker's public registry, create an account on Docker Hub.
19 20
 
20
-This stores encoded credentials in `$HOME/.dockercfg` on Linux or `%USERPROFILE%/.dockercfg`
21
-on Windows.
21
+You can log into any public or private repository for which you have
22
+credentials.  When you log in, the command stores encoded credentials in
23
+`$HOME/.dockercfg` on Linux or `%USERPROFILE%/.dockercfg` on Windows.
22 24
 
23 25
 # OPTIONS
24 26
 **-e**, **--email**=""
... ...
@@ -35,7 +37,7 @@ on Windows.
35 35
 
36 36
 # EXAMPLES
37 37
 
38
-## Login to a local registry
38
+## Login to a registry on your localhost
39 39
 
40 40
     # docker login localhost:8080
41 41
 
... ...
@@ -46,3 +48,4 @@ on Windows.
46 46
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
47 47
 based on docker.com source material and internal work.
48 48
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
49
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
... ...
@@ -2,23 +2,24 @@
2 2
 % Docker Community
3 3
 % JUNE 2014
4 4
 # NAME
5
-docker-logout - Log out from a Docker registry, if no server is specified "https://index.docker.io/v1/" is the default.
5
+docker-logout - Log out from a Docker Registry Service.
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker logout**
9 9
 [SERVER]
10 10
 
11 11
 # DESCRIPTION
12
-Log the user out from a Docker registry, if no server is
13
-specified "https://index.docker.io/v1/" is the default. If you want to
14
-log out from a private registry you can specify this by adding the server name.
12
+Log out of a Docker Registry Service located on the specified `SERVER`. You can
13
+specify a URL or a `hostname` for the `SERVER` value. If you do not specify a
14
+`SERVER`, the command attempts to log you out of Docker's public registry
15
+located at `https://registry-1.docker.io/` by default.  
15 16
 
16 17
 # OPTIONS
17 18
 There are no available options.
18 19
 
19 20
 # EXAMPLES
20 21
 
21
-## Log out from a local registry
22
+## Log out from a registry on your localhost
22 23
 
23 24
     # docker logout localhost:8080
24 25
 
... ...
@@ -28,3 +29,4 @@ There are no available options.
28 28
 # HISTORY
29 29
 June 2014, Originally compiled by Daniel, Dao Quang Minh (daniel at nitrous dot io)
30 30
 July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
31
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
... ...
@@ -2,7 +2,7 @@
2 2
 % Docker Community
3 3
 % JUNE 2014
4 4
 # NAME
5
-docker-pull - Pull an image or a repository from the registry
5
+docker-pull - Pull an image or a repository from a registry
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker pull**
... ...
@@ -12,10 +12,12 @@ NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG]
12 12
 
13 13
 # DESCRIPTION
14 14
 
15
-This command pulls down an image or a repository from the registry. If
15
+This command pulls down an image or a repository from a registry. If
16 16
 there is more than one image for a repository (e.g., fedora) then all
17 17
 images for that repository name are pulled down including any tags.
18
-It is also possible to specify a non-default registry to pull from.
18
+
19
+If you do not specify a `REGISTRY_HOST`, the command uses Docker's public
20
+registry located at `registry-1.docker.io` by default. 
19 21
 
20 22
 # OPTIONS
21 23
 **-a**, **--all-tags**=*true*|*false*
... ...
@@ -45,7 +47,7 @@ It is also possible to specify a non-default registry to pull from.
45 45
     fedora       heisenbug   105182bb5e8b    5 days ago   372.7 MB
46 46
     fedora       latest      105182bb5e8b    5 days ago   372.7 MB
47 47
 
48
-# Pull an image, manually specifying path to the registry and tag
48
+# Pull an image, manually specifying path to Docker's public registry and tag
49 49
 # Note that if the  image is previously downloaded then the status would be
50 50
 # 'Status: Image is up to date for registry.hub.docker.com/fedora:20'
51 51
 
... ...
@@ -68,3 +70,4 @@ based on docker.com source material and internal work.
68 68
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
69 69
 August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
70 70
 April 2015, updated by John Willis <john.willis@docker.com>
71
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
... ...
@@ -2,18 +2,18 @@
2 2
 % Docker Community
3 3
 % JUNE 2014
4 4
 # NAME
5
-docker-push - Push an image or a repository to the registry
5
+docker-push - Push an image or a repository to a registry
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker push**
9 9
 [**--help**]
10
-NAME[:TAG]
10
+NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG]
11 11
 
12 12
 # DESCRIPTION
13
-Push an image or a repository to a registry. The default registry is the Docker 
14
-Hub located at [hub.docker.com](https://hub.docker.com/). However the 
15
-image can be pushed to another, perhaps private, registry as demonstrated in 
16
-the example below.
13
+
14
+This command pushes an image or a repository to a registry. If you do not
15
+specify a `REGISTRY_HOST`, the command uses Docker's public registry located at
16
+`registry-1.docker.io` by default. 
17 17
 
18 18
 # OPTIONS
19 19
 **--help**
... ...
@@ -28,12 +28,10 @@ and then committing it to a new image name:
28 28
 
29 29
     # docker commit c16378f943fe rhel-httpd
30 30
 
31
-Now push the image to the registry using the image ID. In this example
32
-the registry is on host named registry-host and listening on port 5000.
33
-Default Docker commands will push to the default `hub.docker.com`
34
-registry. Instead, push to the local registry, which is on a host called
35
-registry-host*. To do this, tag the image with the host name or IP
36
-address, and the port of the registry:
31
+Now, push the image to the registry using the image ID. In this example the
32
+registry is on host named `registry-host` and listening on port `5000`. To do
33
+this, tag the image with the host name or IP address, and the port of the
34
+registry:
37 35
 
38 36
     # docker tag rhel-httpd registry-host:5000/myadmin/rhel-httpd
39 37
     # docker push registry-host:5000/myadmin/rhel-httpd
... ...
@@ -49,3 +47,5 @@ listed.
49 49
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
50 50
 based on docker.com source material and internal work.
51 51
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
52
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
53
+
... ...
@@ -13,10 +13,9 @@ IMAGE [IMAGE...]
13 13
 
14 14
 # DESCRIPTION
15 15
 
16
-This will remove one or more images from the host node. This does not
17
-remove images from a registry. You cannot remove an image of a running
18
-container unless you use the **-f** option. To see all images on a host
19
-use the **docker images** command.
16
+Removes one or more images from the host node. This does not remove images from
17
+a registry. You cannot remove an image of a running container unless you use the
18
+**-f** option. To see all images on a host use the **docker images** command.
20 19
 
21 20
 # OPTIONS
22 21
 **-f**, **--force**=*true*|*false*
... ...
@@ -40,3 +39,4 @@ Here is an example of removing and image:
40 40
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
41 41
 based on docker.com source material and internal work.
42 42
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
43
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
... ...
@@ -14,10 +14,9 @@ TERM
14 14
 
15 15
 # DESCRIPTION
16 16
 
17
-Search an index for an image with that matches the term TERM. The table
18
-of images returned displays the name, description (truncated by default),
19
-number of stars awarded, whether the image is official, and whether it
20
-is automated.
17
+Search Docker Hub for an image with that matches the specified `TERM`. The table
18
+of images returned displays the name, description (truncated by default), number
19
+of stars awarded, whether the image is official, and whether it is automated.
21 20
 
22 21
 *Note* - Search queries will only return up to 25 results
23 22
 
... ...
@@ -36,9 +35,9 @@ is automated.
36 36
 
37 37
 # EXAMPLES
38 38
 
39
-## Search the registry for ranked images
39
+## Search Docker Hub for ranked images
40 40
 
41
-Search the registry for the term 'fedora' and only display those images
41
+Search a registry for the term 'fedora' and only display those images
42 42
 ranked 3 or higher:
43 43
 
44 44
     $ docker search -s 3 fedora
... ...
@@ -48,9 +47,9 @@ ranked 3 or higher:
48 48
     mattdm/fedora-small   A small Fedora image on which to build. Co...  8
49 49
     goldmann/wildfly      A WildFly application server running on a ...  3               [OK]
50 50
 
51
-## Search the registry for automated images
51
+## Search Docker Hub for automated images
52 52
 
53
-Search the registry for the term 'fedora' and only display automated images
53
+Search Docker Hub for the term 'fedora' and only display automated images
54 54
 ranked 1 or higher:
55 55
 
56 56
     $ docker search -s 1 -t fedora
... ...
@@ -62,3 +61,5 @@ ranked 1 or higher:
62 62
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
63 63
 based on docker.com source material and internal work.
64 64
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
65
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
66
+
... ...
@@ -8,11 +8,14 @@ docker-tag - Tag an image into a repository
8 8
 **docker tag**
9 9
 [**-f**|**--force**[=*false*]]
10 10
 [**--help**]
11
-IMAGE[:TAG] [REGISTRYHOST/][USERNAME/]NAME[:TAG]
11
+IMAGE[:TAG] [REGISTRY_HOST/][USERNAME/]NAME[:TAG]
12 12
 
13 13
 # DESCRIPTION
14
-This will give a new alias to an image in the repository. This refers to the
15
-entire image name including the optional TAG after the ':'. 
14
+Assigns a new alias to an image in a registry. An alias refers to the
15
+entire image name including the optional `TAG` after the ':'. 
16
+
17
+If you do not specify a `REGISTRY_HOST`, the command uses Docker's public
18
+registry located at `registry-1.docker.io` by default. 
16 19
 
17 20
 # "OPTIONS"
18 21
 **-f**, **--force**=*true*|*false*
... ...
@@ -58,3 +61,5 @@ April 2014, Originally compiled by William Henry (whenry at redhat dot com)
58 58
 based on docker.com source material and internal work.
59 59
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
60 60
 July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
61
+April 2015, updated by Mary Anthony for v2 <mary@docker.com>
62
+
... ...
@@ -172,10 +172,10 @@ inside it)
172 172
   Load an image from a tar archive
173 173
 
174 174
 **docker-login(1)**
175
-  Register or Login to a Docker registry server
175
+  Register or login to a Docker Registry Service
176 176
 
177 177
 **docker-logout(1)**
178
-  Log the user out of a Docker registry server
178
+  Log the user out of a Docker Registry Service
179 179
 
180 180
 **docker-logs(1)**
181 181
   Fetch the logs of a container
... ...
@@ -190,10 +190,10 @@ inside it)
190 190
   List containers
191 191
 
192 192
 **docker-pull(1)**
193
-  Pull an image or a repository from a Docker registry server
193
+  Pull an image or a repository from a Docker Registry Service
194 194
 
195 195
 **docker-push(1)**
196
-  Push an image or a repository to a Docker registry server
196
+  Push an image or a repository to a Docker Registry Service
197 197
 
198 198
 **docker-restart(1)**
199 199
   Restart a running container