Merge pull request docker#4715 from craig-osterhout/freshness-q4

docs: fix typos and update formatting

docs/reference/commandline/image_prune.md

@@ -16,7 +16,7 @@ Remove unused images
 
 ## Description
 
-Remove all dangling images. If `-a` is specified, will also remove all images not referenced by any container.
+Remove all dangling images. If `-a` is specified, also remove all images not referenced by any container.
 
 ## Examples
 
@@ -89,10 +89,10 @@ images without the specified labels.
 > same filtering syntax to see which images match your filter.
 >
 > However, if you are using negative filtering (testing for the absence of a
-> label or that a label does *not* have a specific value), this type of filter
-> does not work with `docker image ls` so you cannot easily predict which images
+> label or that a label doesn't have a specific value), this type of filter
+> doesn't work with `docker image ls` so you cannot easily predict which images
 > will be removed. In addition, the confirmation prompt for `docker image prune`
-> always warns that *all* dangling images will be removed, even if you are using
+> always warns that all dangling images will be removed, even if you are using
 > `--filter`.
 
 The following removes images created before `2017-01-04T00:00:00`:
@@ -190,7 +190,7 @@ $ docker image prune --filter="label!=maintainer=john"
 >
 > You are prompted for confirmation before the `prune` removes
 > anything, but you are not shown a list of what will potentially be removed.
-> In addition, `docker image ls` does not support negative filtering, so it
+> In addition, `docker image ls` doesn't support negative filtering, so it
 > difficult to predict what images will actually be removed.
 
 ## Related commands

docs/reference/commandline/images.md

@@ -65,7 +65,7 @@ that restricts the list to images that match the argument. If you specify
 `REPOSITORY`but no `TAG`, the `docker images` command lists all images in the
 given repository.
 
-For example, to list all images in the "java" repository, run this command :
+For example, to list all images in the `java` repository, run the following command:
 
 ```console
 $ docker images java
@@ -76,12 +76,12 @@ java                7                   493d82594c15        3 months ago
 java                latest              2711b1d6f3aa        5 months ago        603.9 MB
 ```
 
-The `[REPOSITORY[:TAG]]` value must be an "exact match". This means that, for example,
+The `[REPOSITORY[:TAG]]` value must be an exact match. This means that, for example,
 `docker images jav` does not match the image `java`.
 
 If both `REPOSITORY` and `TAG` are provided, only images matching that
-repository and tag are listed.  To find all local images in the "java"
-repository with tag "8" you can use:
+repository and tag are listed.  To find all local images in the `java`
+repository with tag `8` you can use:
 
 ```console
 $ docker images java:8
@@ -136,7 +136,7 @@ also reference by digest in `create`, `run`, and `rmi` commands, as well as the
 ### <a name="filter"></a> Filtering (--filter)
 
 The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
-than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
+than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`).
 
 The currently supported filters are:
 
@@ -166,7 +166,7 @@ intermediary layers). These images occur when a new build of an image takes the
 A warning will be issued if trying to remove an image when a container is presently
 using it. By having this flag it allows for batch cleanup.
 
-You can use this in conjunction with `docker rmi ...`:
+You can use this in conjunction with `docker rmi`:
 
 ```console
 $ docker rmi $(docker images -f "dangling=true" -q)
@@ -216,7 +216,7 @@ REPOSITORY          TAG                 IMAGE ID            CREATED
 #### Filter images by time
 
 The `before` filter shows only images created before the image with
-given id or reference. For example, having these images:
+a given ID or reference. For example, having these images:
 
 ```console
 $ docker images

docs/reference/commandline/inspect.md

@@ -38,7 +38,7 @@ exist with the same name, making the result ambiguous.
 To restrict `docker inspect` to a specific type of object, use the `--type`
 option.
 
-The following example inspects a _volume_ named "myvolume"
+The following example inspects a volume named `myvolume`.
 
 ```console
 $ docker inspect --type=volume myvolume
@@ -117,7 +117,7 @@ the template language's `index` function does. The `.NetworkSettings.Ports`
 section contains a map of the internal port mappings to a list of external
 address/port objects. To grab just the numeric public port, you use `index` to
 find the specific port map, and then `index` 0 contains the first object inside
-of that. Then we ask for the `HostPort` field to get the public address.
+of that. Then, specify the `HostPort` field to get the public address.
 
 ```console
 $ docker inspect --format='{{(index (index .NetworkSettings.Ports "8787/tcp") 0).HostPort}}' $INSTANCE_ID

docs/reference/commandline/login.md

@@ -17,13 +17,13 @@ If no server is specified, the default is defined by the daemon.
 
 ## Description
 
-Login to a registry.
+Log in to a registry.
 
 ## Examples
 
 ### Login to a self-hosted registry
 
-If you want to login to a self-hosted registry you can specify this by
+If you want to log in to a self-hosted registry you can specify this by
 adding the server name.
 
 ```console
@@ -46,12 +46,12 @@ $ cat ~/my_password.txt | docker login --username foo --password-stdin
 
 ### Privileged user requirement
 
-`docker login` requires user to use `sudo` or be `root`, except when:
+`docker login` requires you to use `sudo` or be `root`, except when:
 
-1.  connecting to a remote daemon, such as a `docker-machine` provisioned `docker engine`.
-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.
+- Connecting to a remote daemon, such as a `docker-machine` provisioned `docker engine`.
+- 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.
 
-You can log into any public or private repository for which you have
+You can log in to any public or private repository for which you have
 credentials.  When you log in, the command stores credentials in
 `$HOME/.docker/config.json` on Linux or `%USERPROFILE%/.docker/config.json` on
 Windows, via the procedure described below.
@@ -78,7 +78,7 @@ Helpers are available for the following credential stores:
 #### Configure the credential store
 
 You need to specify the credential store in `$HOME/.docker/config.json`
-to tell the docker engine to use it. The value of the config property should be
+to tell the Docker Engine to use it. The value of the config property should be
 the suffix of the program to use (i.e. everything after `docker-credential-`).
 For example, to use `docker-credential-osxkeychain`:
 
@@ -123,11 +123,11 @@ or an identity token.
 If the secret being stored is an identity token, the Username should be set to
 `<token>`.
 
-The `store` command can write error messages to `STDOUT` that the docker engine
+The `store` command can write error messages to `STDOUT` that the Docker Engine
 will show if there was an issue.
 
 The `get` command takes a string payload from the standard input. That payload carries
-the server address that the docker engine needs credentials for. This is
+the server address that the Docker Engine needs credentials for. This is
 an example of that payload: `https://index.docker.io/v1`.
 
 The `get` command writes a JSON payload to `STDOUT`. Docker reads the user name
@@ -141,16 +141,16 @@ and password from this payload:
 ```
 
 The `erase` command takes a string payload from `STDIN`. That payload carries
-the server address that the docker engine wants to remove credentials for. This is
+the server address that the Docker Engine wants to remove credentials for. This is
 an example of that payload: `https://index.docker.io/v1`.
 
-The `erase` command can write error messages to `STDOUT` that the docker engine
+The `erase` command can write error messages to `STDOUT` that the Docker Engine
 will show if there was an issue.
 
 ### Credential helpers
 
 Credential helpers are similar to the credential store above, but act as the
-designated programs to handle credentials for *specific registries*. The default
+designated programs to handle credentials for specific registries. The default
 credential store (`credsStore` or the config file itself) will not be used for
 operations concerning credentials of the specified registries.
 

docs/reference/commandline/manifest.md

@@ -33,9 +33,9 @@ For full details on using docker manifest lists, see the registry v2 specificati
 The `docker manifest` command by itself performs no action. In order to operate
 on a manifest or manifest list, one of the subcommands must be used.
 
-A single manifest is information about an image, such as layers, size, and digest.
-The docker manifest command also gives users additional information such as the os
-and architecture an image was built for.
+A single manifest is information about an image, such as layers, size, and
+digest. The `docker manifest` command also gives you additional information,
+such as the OS and architecture an image was built for.
 
 A manifest list is a list of image layers that is created by specifying one or
 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.
 Ideally a manifest list is created from images that are identical in function for
 different os/arch combinations. For this reason, manifest lists are often referred
 to as "multi-arch images". However, a user could create a manifest list that points
-to two images -- one for windows on amd64, and one for darwin on amd64.
+to two images -- one for Windows on AMD64, and one for Darwin on AMD64.
 
 ### manifest inspect
 
@@ -143,10 +143,10 @@ $ docker manifest inspect hello-world
 
 ### Inspect an image's manifest and get the os/arch info
 
-The `docker manifest inspect` command takes an optional `--verbose` flag
-that gives you the image's name (Ref), and architecture and os (Platform).
+The `docker manifest inspect` command takes an optional `--verbose` flag that
+gives you the image's name (Ref), as well as the architecture and OS (Platform).
 
-Just as with other docker commands that take image names, you can refer to an image with or
+Just as with other Docker commands that take image names, you can refer to an image with or
 without a tag, or by digest (e.g. `hello-world@sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f`).
 
 Here is an example of inspecting an image's manifest with the `--verbose` flag:

docs/reference/commandline/network_connect.md

@@ -50,7 +50,7 @@ $ docker network connect --ip 10.10.36.122 multi-host-network container2
 
 ### <a name="link"></a> Use the legacy `--link` option (--link)
 
-You can use `--link` option to link another container with a preferred alias
+You can use `--link` option to link another container with a preferred alias.
 
 ```console
 $ docker network connect --link container1:c1 multi-host-network container2

docs/reference/commandline/network_create.md

@@ -34,7 +34,7 @@ built-in network drivers. If you have installed a third party or your own custom
 network driver you can specify that `DRIVER` here also. If you don't specify the
 `--driver` option, the command automatically creates a `bridge` network for you.
 When you install Docker Engine it creates a `bridge` network automatically. This
-network corresponds to the `docker0` bridge that Engine has traditionally relied
+network corresponds to the `docker0` bridge that Docker Engine has traditionally relied
 on. When you launch a new container with  `docker run` it automatically connects to
 this bridge network. You cannot remove this default bridge network, but you can
 create new ones using the `network create` command.
@@ -43,8 +43,8 @@ create new ones using the `network create` command.
 $ docker network create -d bridge my-bridge-network
 ```
 
-Bridge networks are isolated networks on a single Engine installation. If you
-want to create a network that spans multiple Docker hosts each running an
+Bridge networks are isolated networks on a single Docker Engine installation. If you
+want to create a network that spans multiple Docker hosts each running Docker
 Engine, you must enable Swarm mode, and create an `overlay` network. To read more
 about overlay networks with Swarm mode, see ["*use overlay networks*"](https://docs.docker.com/network/overlay/).
 
@@ -97,17 +97,17 @@ You can connect multiple containers to the same network. Once connected, the
 containers can communicate using only another container's IP address or name.
 For `overlay` networks or custom plugins that support multi-host connectivity,
 containers connected to the same multi-host network but launched from different
-Engines can also communicate in this way.
+daemons can also communicate in this way.
 
 You can disconnect a container from a network using the `docker network
 disconnect` command.
 
 ### Specify advanced options
 
-When you create a network, Engine creates a non-overlapping subnetwork for the
-network by default. This subnetwork is not a subdivision of an existing network.
-It is purely for ip-addressing purposes. You can override this default and
-specify subnetwork values directly using the `--subnet` option. On a
+When you create a network, Docker Engine creates a non-overlapping subnetwork
+for the network by default. This subnetwork is not a subdivision of an existing
+network. It is purely for ip-addressing purposes. You can override this default
+and specify subnetwork values directly using the `--subnet` option. On a
 `bridge` network you can only create a single subnet:
 
 ```console
@@ -126,8 +126,8 @@ $ docker network create \
   br0
 ```
 
-If you omit the `--gateway` flag the Engine selects one for you from inside a
-preferred pool. For `overlay` networks and for network driver plugins that
+If you omit the `--gateway` flag, Docker Engine selects one for you from inside
+a preferred pool. For `overlay` networks and for network driver plugins that
 support it you can create multiple subnetworks. This example uses two `/25`
 subnet mask to adhere to the current guidance of not having more than 256 IPs in
 a single overlay network. Each of the subnetworks has 126 usable addresses.
@@ -144,13 +144,13 @@ $ docker network create -d overlay \
 ```
 
 Be sure that your subnetworks do not overlap. If they do, the network create
-fails and Engine returns an error.
+fails and Docker Engine returns an error.
 
 ### Bridge driver options
 
 When creating a custom network, the default network driver (i.e. `bridge`) has
 additional options that can be passed. The following are those options and the
-equivalent docker daemon flags used for docker0 bridge:
+equivalent Docker daemon flags used for docker0 bridge:
 
 | Option                                           | Equivalent  | Description                                           |
 |--------------------------------------------------|-------------|-------------------------------------------------------|
@@ -207,7 +207,7 @@ $ docker network create -d overlay \
 
 ### Run services on predefined networks
 
-You can create services on the predefined docker networks `bridge` and `host`.
+You can create services on the predefined Docker networks `bridge` and `host`.
 
 ```console
 $ docker service create --name my-service \

docs/reference/commandline/node_ps.md

@@ -44,8 +44,9 @@ redis.10.0tgctg8h8cech4w0k0gwrmr23  redis:3.0.6  swarm-manager1  Running
 
 ### <a name="filter"></a> Filtering (--filter)
 
-The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
-than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
+The filtering flag (`-f` or `--filter`) format is of "key=value". If there is
+more than one filter, then pass multiple flags (e.g., `--filter "foo=bar"
+--filter "bif=baz"`).
 
 The currently supported filters are:
 

docs/reference/commandline/node_rm.md

@@ -42,7 +42,7 @@ Node swarm-node-02 removed from swarm
 Removes the specified nodes from the swarm, but only if the nodes are in the
 down state. If you attempt to remove an active node you will receive an error:
 
-```non
+```console
 $ docker node rm swarm-node-03
 
 Error response from daemon: rpc error: code = 9 desc = node swarm-node-03 is not

docs/reference/commandline/plugin_create.md

@@ -14,8 +14,8 @@ Create a plugin from a rootfs and configuration. Plugin data directory must cont
 
 ## Description
 
-Creates a plugin. Before creating the plugin, prepare the plugin's root filesystem as well as
-[the config.json](../../extend/config.md)
+Creates a plugin. Before creating the plugin, prepare the plugin's root
+filesystem as well as the [config.json](../../extend/config.md).
 
 ## Examples
 

docs/reference/commandline/plugin_install.md

@@ -20,7 +20,7 @@ Install a plugin
 Installs and enables a plugin. Docker looks first for the plugin on your Docker
 host. If the plugin does not exist locally, then the plugin is pulled from
 the registry. Note that the minimum required registry version to distribute
-plugins is 2.3.0
+plugins is 2.3.0.
 
 ## Examples
 

docs/reference/commandline/plugin_ls.md

@@ -38,7 +38,7 @@ ID            NAME                                    DESCRIPTION
 ### <a name="filter"></a> Filtering (--filter)
 
 The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
-than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
+than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`).
 
 The currently supported filters are:
 

docs/reference/commandline/plugin_rm.md

@@ -20,8 +20,8 @@ Remove one or more plugins
 
 Removes a plugin. You cannot remove a plugin if it is enabled, you must disable
 a plugin using the [`docker plugin disable`](plugin_disable.md) before removing
-it (or use --force, use of force is not recommended, since it can affect
-functioning of running containers using the plugin).
+it, or use `--force`. Use of `--force` is not recommended, since it can affect
+functioning of running containers using the plugin.
 
 ## Examples
 

docs/reference/commandline/plugin_set.md

@@ -123,6 +123,7 @@ $ docker plugin inspect -f '{{with $device := index .Settings.Devices 0}}{{$devi
 ```
 
 > **Note**
+>
 > Since only `path` is settable in `mydevice`,
 > `docker plugins set mydevice=/dev/bar myplugin` would work too.