Skip to content

Commit 5eac07b

Browse files
craig-osterhoutdvdksn
authored andcommitted
update typos and style in docs
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
1 parent 5ba998d commit 5eac07b

31 files changed

+110
-106
lines changed

docs/reference/commandline/image_prune.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Remove unused images
1616

1717
## Description
1818

19-
Remove all dangling images. If `-a` is specified, will also remove all images not referenced by any container.
19+
Remove all dangling images. If `-a` is specified, also remove all images not referenced by any container.
2020

2121
## Examples
2222

@@ -89,10 +89,10 @@ images without the specified labels.
8989
> same filtering syntax to see which images match your filter.
9090
>
9191
> However, if you are using negative filtering (testing for the absence of a
92-
> label or that a label does *not* have a specific value), this type of filter
93-
> does not work with `docker image ls` so you cannot easily predict which images
92+
> label or that a label doesn't have a specific value), this type of filter
93+
> doesn't work with `docker image ls` so you cannot easily predict which images
9494
> will be removed. In addition, the confirmation prompt for `docker image prune`
95-
> always warns that *all* dangling images will be removed, even if you are using
95+
> always warns that all dangling images will be removed, even if you are using
9696
> `--filter`.
9797
9898
The following removes images created before `2017-01-04T00:00:00`:
@@ -190,7 +190,7 @@ $ docker image prune --filter="label!=maintainer=john"
190190
>
191191
> You are prompted for confirmation before the `prune` removes
192192
> anything, but you are not shown a list of what will potentially be removed.
193-
> In addition, `docker image ls` does not support negative filtering, so it
193+
> In addition, `docker image ls` doesn't support negative filtering, so it
194194
> difficult to predict what images will actually be removed.
195195
196196
## Related commands

docs/reference/commandline/images.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ that restricts the list to images that match the argument. If you specify
6565
`REPOSITORY`but no `TAG`, the `docker images` command lists all images in the
6666
given repository.
6767

68-
For example, to list all images in the "java" repository, run this command :
68+
For example, to list all images in the `java` repository, run the following command:
6969

7070
```console
7171
$ docker images java
@@ -76,12 +76,12 @@ java 7 493d82594c15 3 months ago
7676
java latest 2711b1d6f3aa 5 months ago 603.9 MB
7777
```
7878

79-
The `[REPOSITORY[:TAG]]` value must be an "exact match". This means that, for example,
79+
The `[REPOSITORY[:TAG]]` value must be an exact match. This means that, for example,
8080
`docker images jav` does not match the image `java`.
8181

8282
If both `REPOSITORY` and `TAG` are provided, only images matching that
83-
repository and tag are listed. To find all local images in the "java"
84-
repository with tag "8" you can use:
83+
repository and tag are listed. To find all local images in the `java`
84+
repository with tag `8` you can use:
8585

8686
```console
8787
$ docker images java:8
@@ -136,7 +136,7 @@ also reference by digest in `create`, `run`, and `rmi` commands, as well as the
136136
### <a name="filter"></a> Filtering (--filter)
137137

138138
The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
139-
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
139+
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`).
140140

141141
The currently supported filters are:
142142

@@ -166,7 +166,7 @@ intermediary layers). These images occur when a new build of an image takes the
166166
A warning will be issued if trying to remove an image when a container is presently
167167
using it. By having this flag it allows for batch cleanup.
168168

169-
You can use this in conjunction with `docker rmi ...`:
169+
You can use this in conjunction with `docker rmi`:
170170

171171
```console
172172
$ docker rmi $(docker images -f "dangling=true" -q)
@@ -216,7 +216,7 @@ REPOSITORY TAG IMAGE ID CREATED
216216
#### Filter images by time
217217

218218
The `before` filter shows only images created before the image with
219-
given id or reference. For example, having these images:
219+
a given ID or reference. For example, having these images:
220220

221221
```console
222222
$ docker images

docs/reference/commandline/inspect.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ exist with the same name, making the result ambiguous.
3838
To restrict `docker inspect` to a specific type of object, use the `--type`
3939
option.
4040

41-
The following example inspects a _volume_ named "myvolume"
41+
The following example inspects a volume named `myvolume`.
4242

4343
```console
4444
$ docker inspect --type=volume myvolume
@@ -117,7 +117,7 @@ the template language's `index` function does. The `.NetworkSettings.Ports`
117117
section contains a map of the internal port mappings to a list of external
118118
address/port objects. To grab just the numeric public port, you use `index` to
119119
find the specific port map, and then `index` 0 contains the first object inside
120-
of that. Then we ask for the `HostPort` field to get the public address.
120+
of that. Then, specify the `HostPort` field to get the public address.
121121

122122
```console
123123
$ docker inspect --format='{{(index (index .NetworkSettings.Ports "8787/tcp") 0).HostPort}}' $INSTANCE_ID

docs/reference/commandline/login.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ If no server is specified, the default is defined by the daemon.
1717

1818
## Description
1919

20-
Login to a registry.
20+
Log in to a registry.
2121

2222
## Examples
2323

2424
### Login to a self-hosted registry
2525

26-
If you want to login to a self-hosted registry you can specify this by
26+
If you want to log in to a self-hosted registry you can specify this by
2727
adding the server name.
2828

2929
```console
@@ -46,12 +46,12 @@ $ cat ~/my_password.txt | docker login --username foo --password-stdin
4646

4747
### Privileged user requirement
4848

49-
`docker login` requires user to use `sudo` or be `root`, except when:
49+
`docker login` requires you to use `sudo` or be `root`, except when:
5050

51-
1. connecting to a remote daemon, such as a `docker-machine` provisioned `docker engine`.
52-
2. user is added to the `docker` group. This will impact the security of your system; the `docker` group is `root` equivalent. See [Docker Daemon Attack Surface](https://docs.docker.com/engine/security/#docker-daemon-attack-surface) for details.
51+
- Connecting to a remote daemon, such as a `docker-machine` provisioned `docker engine`.
52+
- The user is added to the `docker` group. This will impact the security of your system; the `docker` group is `root` equivalent. See [Docker Daemon Attack Surface](https://docs.docker.com/engine/security/#docker-daemon-attack-surface) for details.
5353

54-
You can log into any public or private repository for which you have
54+
You can log in to any public or private repository for which you have
5555
credentials. When you log in, the command stores credentials in
5656
`$HOME/.docker/config.json` on Linux or `%USERPROFILE%/.docker/config.json` on
5757
Windows, via the procedure described below.
@@ -78,7 +78,7 @@ Helpers are available for the following credential stores:
7878
#### Configure the credential store
7979

8080
You need to specify the credential store in `$HOME/.docker/config.json`
81-
to tell the docker engine to use it. The value of the config property should be
81+
to tell the Docker Engine to use it. The value of the config property should be
8282
the suffix of the program to use (i.e. everything after `docker-credential-`).
8383
For example, to use `docker-credential-osxkeychain`:
8484

@@ -123,11 +123,11 @@ or an identity token.
123123
If the secret being stored is an identity token, the Username should be set to
124124
`<token>`.
125125

126-
The `store` command can write error messages to `STDOUT` that the docker engine
126+
The `store` command can write error messages to `STDOUT` that the Docker Engine
127127
will show if there was an issue.
128128

129129
The `get` command takes a string payload from the standard input. That payload carries
130-
the server address that the docker engine needs credentials for. This is
130+
the server address that the Docker Engine needs credentials for. This is
131131
an example of that payload: `https://index.docker.io/v1`.
132132

133133
The `get` command writes a JSON payload to `STDOUT`. Docker reads the user name
@@ -141,16 +141,16 @@ and password from this payload:
141141
```
142142

143143
The `erase` command takes a string payload from `STDIN`. That payload carries
144-
the server address that the docker engine wants to remove credentials for. This is
144+
the server address that the Docker Engine wants to remove credentials for. This is
145145
an example of that payload: `https://index.docker.io/v1`.
146146

147-
The `erase` command can write error messages to `STDOUT` that the docker engine
147+
The `erase` command can write error messages to `STDOUT` that the Docker Engine
148148
will show if there was an issue.
149149

150150
### Credential helpers
151151

152152
Credential helpers are similar to the credential store above, but act as the
153-
designated programs to handle credentials for *specific registries*. The default
153+
designated programs to handle credentials for specific registries. The default
154154
credential store (`credsStore` or the config file itself) will not be used for
155155
operations concerning credentials of the specified registries.
156156

docs/reference/commandline/manifest.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ For full details on using docker manifest lists, see the registry v2 specificati
3333
The `docker manifest` command by itself performs no action. In order to operate
3434
on a manifest or manifest list, one of the subcommands must be used.
3535

36-
A single manifest is information about an image, such as layers, size, and digest.
37-
The docker manifest command also gives users additional information such as the os
38-
and architecture an image was built for.
36+
A single manifest is information about an image, such as layers, size, and
37+
digest. The `docker manifest` command also gives you additional information,
38+
such as the OS and architecture an image was built for.
3939

4040
A manifest list is a list of image layers that is created by specifying one or
4141
more (ideally more than one) image names. It can then be used in the same way as
@@ -44,7 +44,7 @@ an image name in `docker pull` and `docker run` commands, for example.
4444
Ideally a manifest list is created from images that are identical in function for
4545
different os/arch combinations. For this reason, manifest lists are often referred
4646
to as "multi-arch images". However, a user could create a manifest list that points
47-
to two images -- one for windows on amd64, and one for darwin on amd64.
47+
to two images -- one for Windows on AMD64, and one for Darwin on AMD64.
4848

4949
### manifest inspect
5050

@@ -143,10 +143,10 @@ $ docker manifest inspect hello-world
143143

144144
### Inspect an image's manifest and get the os/arch info
145145

146-
The `docker manifest inspect` command takes an optional `--verbose` flag
147-
that gives you the image's name (Ref), and architecture and os (Platform).
146+
The `docker manifest inspect` command takes an optional `--verbose` flag that
147+
gives you the image's name (Ref), as well as the architecture and OS (Platform).
148148

149-
Just as with other docker commands that take image names, you can refer to an image with or
149+
Just as with other Docker commands that take image names, you can refer to an image with or
150150
without a tag, or by digest (e.g. `hello-world@sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f`).
151151

152152
Here is an example of inspecting an image's manifest with the `--verbose` flag:

docs/reference/commandline/network_connect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ $ docker network connect --ip 10.10.36.122 multi-host-network container2
5050

5151
### <a name="link"></a> Use the legacy `--link` option (--link)
5252

53-
You can use `--link` option to link another container with a preferred alias
53+
You can use `--link` option to link another container with a preferred alias.
5454

5555
```console
5656
$ docker network connect --link container1:c1 multi-host-network container2

docs/reference/commandline/network_create.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ built-in network drivers. If you have installed a third party or your own custom
3434
network driver you can specify that `DRIVER` here also. If you don't specify the
3535
`--driver` option, the command automatically creates a `bridge` network for you.
3636
When you install Docker Engine it creates a `bridge` network automatically. This
37-
network corresponds to the `docker0` bridge that Engine has traditionally relied
37+
network corresponds to the `docker0` bridge that Docker Engine has traditionally relied
3838
on. When you launch a new container with `docker run` it automatically connects to
3939
this bridge network. You cannot remove this default bridge network, but you can
4040
create new ones using the `network create` command.
@@ -43,8 +43,8 @@ create new ones using the `network create` command.
4343
$ docker network create -d bridge my-bridge-network
4444
```
4545

46-
Bridge networks are isolated networks on a single Engine installation. If you
47-
want to create a network that spans multiple Docker hosts each running an
46+
Bridge networks are isolated networks on a single Docker Engine installation. If you
47+
want to create a network that spans multiple Docker hosts each running Docker
4848
Engine, you must enable Swarm mode, and create an `overlay` network. To read more
4949
about overlay networks with Swarm mode, see ["*use overlay networks*"](https://docs.docker.com/network/overlay/).
5050

@@ -97,17 +97,17 @@ You can connect multiple containers to the same network. Once connected, the
9797
containers can communicate using only another container's IP address or name.
9898
For `overlay` networks or custom plugins that support multi-host connectivity,
9999
containers connected to the same multi-host network but launched from different
100-
Engines can also communicate in this way.
100+
daemons can also communicate in this way.
101101

102102
You can disconnect a container from a network using the `docker network
103103
disconnect` command.
104104

105105
### Specify advanced options
106106

107-
When you create a network, Engine creates a non-overlapping subnetwork for the
108-
network by default. This subnetwork is not a subdivision of an existing network.
109-
It is purely for ip-addressing purposes. You can override this default and
110-
specify subnetwork values directly using the `--subnet` option. On a
107+
When you create a network, Docker Engine creates a non-overlapping subnetwork
108+
for the network by default. This subnetwork is not a subdivision of an existing
109+
network. It is purely for ip-addressing purposes. You can override this default
110+
and specify subnetwork values directly using the `--subnet` option. On a
111111
`bridge` network you can only create a single subnet:
112112

113113
```console
@@ -126,8 +126,8 @@ $ docker network create \
126126
br0
127127
```
128128

129-
If you omit the `--gateway` flag the Engine selects one for you from inside a
130-
preferred pool. For `overlay` networks and for network driver plugins that
129+
If you omit the `--gateway` flag, Docker Engine selects one for you from inside
130+
a preferred pool. For `overlay` networks and for network driver plugins that
131131
support it you can create multiple subnetworks. This example uses two `/25`
132132
subnet mask to adhere to the current guidance of not having more than 256 IPs in
133133
a single overlay network. Each of the subnetworks has 126 usable addresses.
@@ -144,13 +144,13 @@ $ docker network create -d overlay \
144144
```
145145

146146
Be sure that your subnetworks do not overlap. If they do, the network create
147-
fails and Engine returns an error.
147+
fails and Docker Engine returns an error.
148148

149149
### Bridge driver options
150150

151151
When creating a custom network, the default network driver (i.e. `bridge`) has
152152
additional options that can be passed. The following are those options and the
153-
equivalent docker daemon flags used for docker0 bridge:
153+
equivalent Docker daemon flags used for docker0 bridge:
154154

155155
| Option | Equivalent | Description |
156156
|--------------------------------------------------|-------------|-------------------------------------------------------|
@@ -207,7 +207,7 @@ $ docker network create -d overlay \
207207

208208
### Run services on predefined networks
209209

210-
You can create services on the predefined docker networks `bridge` and `host`.
210+
You can create services on the predefined Docker networks `bridge` and `host`.
211211

212212
```console
213213
$ docker service create --name my-service \

docs/reference/commandline/node_ps.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@ redis.10.0tgctg8h8cech4w0k0gwrmr23 redis:3.0.6 swarm-manager1 Running
4444

4545
### <a name="filter"></a> Filtering (--filter)
4646

47-
The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
48-
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
47+
The filtering flag (`-f` or `--filter`) format is of "key=value". If there is
48+
more than one filter, then pass multiple flags (e.g., `--filter "foo=bar"
49+
--filter "bif=baz"`).
4950

5051
The currently supported filters are:
5152

docs/reference/commandline/node_rm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Node swarm-node-02 removed from swarm
4242
Removes the specified nodes from the swarm, but only if the nodes are in the
4343
down state. If you attempt to remove an active node you will receive an error:
4444

45-
```non
45+
```console
4646
$ docker node rm swarm-node-03
4747

4848
Error response from daemon: rpc error: code = 9 desc = node swarm-node-03 is not

docs/reference/commandline/plugin_create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Create a plugin from a rootfs and configuration. Plugin data directory must cont
1414

1515
## Description
1616

17-
Creates a plugin. Before creating the plugin, prepare the plugin's root filesystem as well as
18-
[the config.json](../../extend/config.md)
17+
Creates a plugin. Before creating the plugin, prepare the plugin's root
18+
filesystem as well as the [config.json](../../extend/config.md).
1919

2020
## Examples
2121

0 commit comments

Comments
 (0)