Skip to content

Commit a4f5e30

Browse files
author
Misty Stanley-Jones
authored
Various copyedits to reduce future tense, wordiness, and use of 'please' (docker#5788)
* Reword lots of instances of 'will' * Reword lots of instances of won't * Reword lots of instances of we'll * Eradicate you'll * Eradicate 'be able to' type of phrases * Eradicate 'unable to' type of phrases * Eradicate 'has / have to' type of phrases * Eradicate 'note that' type of phrases * Eradicate 'in order to' type of phrases * Redirect to official Chef and Puppet docs * Eradicate gratuitous 'please' * Reduce use of e.g. * Reduce use of i.e. * Reduce use of N.B. * Get rid of 'sexagesimal' and correct some errors
1 parent 1df7737 commit a4f5e30

File tree

583 files changed

+3732
-4114
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

583 files changed

+3732
-4114
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,5 +124,5 @@ know.
124124
If you have questions about how to write for Docker's documentation, have a look
125125
at the [style guide](https://docs.docker.com/opensource/doc-style/). The style
126126
guide provides guidance about grammar, syntax, formatting, styling, language, or
127-
tone. If something isn't clear in the guide, please submit an issue to let us
127+
tone. If something isn't clear in the guide, submit an issue to let us
128128
know or submit a pull request to help us improve it.

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ We really want your feedback, and we've made it easy. You can edit, rate, or
1212
file an issue at the bottom of every page on
1313
[https://docs.docker.com/](https://docs.docker.com/).
1414

15-
**Please only file issues about the documentation in this repository.** One way
15+
**Only file issues about the documentation in this repository.** One way
1616
to think about this is that you should file a bug here if your issue is that you
1717
don't see something that should be in the docs, or you see something incorrect
1818
or confusing in the docs.
@@ -21,7 +21,7 @@ or confusing in the docs.
2121
ask in [https://forums.docker.com](https://forums.docker.com) instead.
2222

2323
- If you have an idea for a new feature or behavior change in a specific aspect
24-
of Docker, or have found a bug in part of Docker, please file that issue in
24+
of Docker, or have found a bug in part of Docker, file that issue in
2525
the project's code repository.
2626

2727
## Contributing
@@ -158,7 +158,7 @@ You have three options:
158158
bundle install
159159
```
160160
161-
>**Note**: You may have to install some packages manually.
161+
>**Note**: You may need to install some packages manually.
162162
163163
f. Change the directory to `docker.github.io`.
164164

_includes/content/compose-extfields-sub.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ x-custom:
1313
name: "custom"
1414
```
1515

16-
The contents of those fields will be ignored by Compose, but they can be
16+
The contents of those fields are ignored by Compose, but they can be
1717
inserted in your resource definitions using [YAML anchors](http://www.yaml.org/spec/1.2/spec.html#id2765878).
1818
For example, if you want several of your services to use the same logging
1919
configuration:

_includes/content/compose-var-sub.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ string. In the example above, if `POSTGRES_VERSION` is not set, the value for
1616
the `image` option is `postgres:`.
1717

1818
You can set default values for environment variables using a
19-
[`.env` file](../env-file.md), which Compose will automatically look for. Values
20-
set in the shell environment will override those set in the `.env` file.
19+
[`.env` file](../env-file.md), which Compose automatically looks for. Values
20+
set in the shell environment override those set in the `.env` file.
2121

2222
> **Important**: The `.env file` feature only works when you use the
2323
> `docker-compose up` command and does not work with `docker stack deploy`.
@@ -27,9 +27,9 @@ Both `$VARIABLE` and `${VARIABLE}` syntax are supported. Additionally when using
2727
the [2.1 file format](compose-versioning.md#version-21), it is possible to
2828
provide inline default values using typical shell syntax:
2929

30-
- `${VARIABLE:-default}` will evaluate to `default` if `VARIABLE` is unset or
30+
- `${VARIABLE:-default}` evaluates to `default` if `VARIABLE` is unset or
3131
empty in the environment.
32-
- `${VARIABLE-default}` will evaluate to `default` only if `VARIABLE` is unset
32+
- `${VARIABLE-default}` evaluates to `default` only if `VARIABLE` is unset
3333
in the environment.
3434

3535
Other extended shell-style features, such as `${VARIABLE/foo/bar}`, are not
@@ -45,6 +45,6 @@ Compose.
4545
command: "$$VAR_NOT_INTERPOLATED_BY_COMPOSE"
4646

4747
If you forget and use a single dollar sign (`$`), Compose interprets the value
48-
as an environment variable and will warn you:
48+
as an environment variable and warns you:
4949

5050
The VAR_NOT_INTERPOLATED_BY_COMPOSE is not set. Substituting an empty string.

_includes/content/ssh/ssh-add-keys-to-agent.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<div id="mac-add-keys" class="tab-pane fade in active">
99
<br>
1010
{% capture mac-content-add %}
11-
1. Start the `ssh-agent` in the background using the command `eval "$(ssh-agent -s)"`. You will get the agent process ID in return.
11+
1. Start the `ssh-agent` in the background using the command `eval "$(ssh-agent -s)"`. You get the agent process ID in return.
1212

1313
```none
1414
eval "$(ssh-agent -s)"

_includes/content/ssh/ssh-find-keys.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
$ ls -al ~/.ssh
5454
```
5555
56-
This will list files in your `.ssh` directory.
56+
This lists files in your `.ssh` directory.
5757
5858
2. Check to see if you already have SSH keys you can use.
5959
@@ -91,7 +91,7 @@
9191
$ ls -al ~/.ssh
9292
```
9393
94-
This will list files in your `.ssh` directory.
94+
This lists files in your `.ssh` directory.
9595
9696
2. Check to see if you already have a SSH keys you can use.
9797

_includes/docker_schedule_matrix.md

+14-19
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
11
{% capture green-check %}![yes](/engine/installation/images/green-check.svg){: style="height: 14px; display: inline-block"}{% endcapture %}
2-
{% capture superscript-link %}[1](#edge-footnote){: style="vertical-align: super; font-size: smaller;" }{% endcapture %}
32
{: style="width: 75%" }
43

5-
| Month | Docker CE Edge | Docker CE Stable |
6-
|:----------|:----------------------------------------|:------------------|
7-
| January | {{ green-check }} | |
8-
| February | {{ green-check }} | |
9-
| March | {{ green-check }}{{ superscript-link }} | {{ green-check }} |
10-
| April | {{ green-check }} | |
11-
| May | {{ green-check }} | |
12-
| June | {{ green-check }}{{ superscript-link }} | {{ green-check }} |
13-
| July | {{ green-check }} | |
14-
| August | {{ green-check }} | |
15-
| September | {{ green-check }}{{ superscript-link }} | {{ green-check }} |
16-
| October | {{ green-check }} | |
17-
| November | {{ green-check }} | |
18-
| December | {{ green-check }}{{ superscript-link }} | {{ green-check }} |
4+
| Month | Docker CE Edge | Docker CE Stable |
5+
|:----------|:------------------|:------------------|
6+
| January | {{ green-check }} | |
7+
| February | {{ green-check }} | |
8+
| March | {{ green-check }} | {{ green-check }} |
9+
| April | {{ green-check }} | |
10+
| May | {{ green-check }} | |
11+
| June | {{ green-check }} | {{ green-check }} |
12+
| July | {{ green-check }} | |
13+
| August | {{ green-check }} | |
14+
| September | {{ green-check }} | {{ green-check }} |
15+
| October | {{ green-check }} | |
16+
| November | {{ green-check }} | |
17+
| December | {{ green-check }} | {{ green-check }} |
1918

20-
`1`: On Linux distributions, these releases will only appear in the `stable`
21-
channels, not the `edge` channels. For that reason, on Linux distributions,
22-
you need to enable both channels.
23-
{: id="edge-footnote" }

_includes/ee-linux-install-reuse.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ You can install Docker EE in different ways, depending on your needs:
5959

6060
2. Temporarily store the Docker EE repository URL you noted down in the
6161
[prerequisites](#prerequisites) in an environment variable.
62-
This will not persist when the current session ends.
62+
This does not persist when the current session ends.
6363

6464
```bash
6565
$ export DOCKERURL='<DOCKER-EE-URL>'
@@ -139,8 +139,8 @@ You can install Docker EE in different ways, depending on your needs:
139139
```
140140

141141
If this is the first time you are installing a package from a recently added
142-
repository, you will be prompted to accept the GPG key, and
143-
the key's fingerprint will be shown. Verify that the fingerprint matches
142+
repository, you are prompted to accept the GPG key, and
143+
the key's fingerprint is shown. Verify that the fingerprint matches
144144
`{{ gpg-fingerprint }}` and if so, accept the key.
145145
146146
2. On production systems, you should install a specific version of Docker EE
@@ -155,7 +155,7 @@ You can install Docker EE in different ways, depending on your needs:
155155
```
156156
157157
The contents of the list depend upon which repositories you have enabled,
158-
and will be specific to your version of {{ linux-dist-long }}
158+
and is specific to your version of {{ linux-dist-long }}
159159
(indicated by the `.el7` suffix on the version, in this example). Choose a
160160
specific version to install. The second column is the version string. You
161161
can use the entire version string, but **you need to include at least to the
@@ -223,7 +223,7 @@ To upgrade Docker EE:
223223
224224
If you cannot use the official Docker repository to install Docker EE, you can
225225
download the `.{{ package-format | downcase }}` file for your release and
226-
install it manually. You will need to download a new file each time you want to
226+
install it manually. You need to download a new file each time you want to
227227
upgrade Docker EE.
228228
229229
{% if linux-dist == "rhel" %}

_includes/install-script.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ non-interactively. The source code for the scripts is in the
1111
environments**, and you should understand the potential risks before you use
1212
them:
1313

14-
- The scripts require `root` or `sudo` privileges in order to run. Therefore,
14+
- The scripts require `root` or `sudo` privileges to run. Therefore,
1515
you should carefully examine and audit the scripts before running them.
1616
- The scripts attempt to detect your Linux distribution and version and
1717
configure your package management system for you. In addition, the scripts do
@@ -22,7 +22,7 @@ them:
2222
manager without asking for confirmation. This may install a large number of
2323
packages, depending on the current configuration of your host machine.
2424
- The script does not provide options to specify which version of Docker to install,
25-
and will install the latest version that is released in the "edge" channel.
25+
and installs the latest version that is released in the "edge" channel.
2626
- Do not use the convenience script if Docker has already been installed on the
2727
host machine using another mechanism.
2828

@@ -48,9 +48,9 @@ adding your user to the "docker" group with something like:
4848

4949
sudo usermod -aG docker your-user
5050

51-
Remember that you will have to log out and back in for this to take effect!
51+
Remember to log out and back in for this to take effect!
5252

53-
WARNING: Adding a user to the "docker" group will grant the ability to run
53+
WARNING: Adding a user to the "docker" group grants the ability to run
5454
containers which can be used to obtain root privileges on the
5555
docker host.
5656
Refer to https://docs.docker.com/engine/security/security/#docker-daemon-attack-surface
@@ -59,8 +59,8 @@ WARNING: Adding a user to the "docker" group will grant the ability to run
5959

6060
Docker CE is installed. It starts automatically on `DEB`-based distributions. On
6161
`RPM`-based distributions, you need to start it manually using the appropriate
62-
`systemctl` or `service` command. As the message indicates, non-root users are
63-
not able to run Docker commands by default.
62+
`systemctl` or `service` command. As the message indicates, non-root users can't
63+
run Docker commands by default.
6464

6565
#### Upgrade Docker after using the convenience script
6666

_includes/why_d4a.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ project was created and is being actively developed to ensure that Docker users
33
can enjoy a fantastic out-of-the-box experience on {{cloudprovider}}. It is now
44
generally available and can now be used by everyone.
55

6-
As an informed user, you might be curious to know what this project has to offer
6+
As an informed user, you might be curious to know what this project offers
77
you for running your development, staging, or production workloads.
88

99
## Native to Docker
@@ -14,12 +14,12 @@ operational complexity and adding unneeded additional APIs to the Docker stack.
1414
Docker for {{cloudprovider}} allows you to interact with Docker directly
1515
(including native Docker orchestration), instead of distracting you with the
1616
need to navigate extra layers on top of Docker. You can focus instead on the
17-
thing that matters most: running your workloads. This will help you and your
17+
thing that matters most: running your workloads. This helps you and your
1818
team to deliver more value to the business faster, to speak one common
1919
"language", and to have fewer details to keep in your head at once.
2020

21-
The skills that you and your team have already learned, and will continue to
22-
learn, using Docker on the desktop or elsewhere will automatically carry over to
21+
The skills that you and your team have already learned, and continue to
22+
learn, using Docker on the desktop or elsewhere automatically carry over to
2323
using Docker on {{cloudprovider}}. The added consistency across clouds also
2424
helps to ensure that a migration or multi-cloud strategy is easier to accomplish
2525
in the future if desired.
@@ -65,12 +65,12 @@ processes. In Docker for {{cloudprovider}}, your cluster is resilient to a
6565
variety of such issues by default.
6666

6767
Log rotation native to the host is configured for you automatically, so chatty
68-
logs won't use up all of your disk space. Likewise, the "system prune" option
68+
logs don't use up all of your disk space. Likewise, the "system prune" option
6969
allows you to ensure unused Docker resources such as old images are cleaned up
7070
automatically. The lifecycle of nodes is managed using auto-scaling groups or
7171
similar constructs, so that if a node enters an unhealthy state for unforeseen
72-
reasons, the node will be taken out of load balancer rotation and/or replaced
73-
automatically and all of its container tasks will be rescheduled.
72+
reasons, the node is taken out of load balancer rotation and/or replaced
73+
automatically and all of its container tasks are rescheduled.
7474

7575
These self-cleaning and self-healing properties are enabled by default and don't
7676
need configuration, so you can breathe easier as the risk of downtime is
@@ -91,7 +91,7 @@ communicating the current state of your infrastructure and the issues you are
9191
seeing to the upstream. In Docker for {{cloudprovider}}, you receive new tools
9292
to communicate any issues you experience quickly and securely to Docker
9393
employees. The Docker for {{cloudprovider}} shell includes a `docker-diagnose`
94-
script which, at your request, will transmit detailed diagnostic information to
94+
script which, at your request, transmits detailed diagnostic information to
9595
Docker support staff to reduce the traditional
9696
"please-post-the-output-of-this-command" back and forth frequently encountered
9797
in bug reports.

apidocs/cloud-api-source/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ dockercloud/api-docs
33

44
[![Deploy to Docker Cloud](https://files.cloud.docker.com/images/deploy-to-dockercloud.svg)](https://cloud.docker.com/stack/deploy/)
55

6-
If you find a typo or mismatch between the API and this documentation, please send us a pull request!
6+
If you find a typo or mismatch between the API and this documentation, send us a pull request!
77

88

99
## Usage

apidocs/cloud-api-source/source/includes/_errors.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ Error Code | Meaning
1717
400 | Bad Request -- There's a problem in the content of your request. Retrying the same request will fail.
1818
401 | Unauthorized -- Your API key is wrong or your account has been deactivated.
1919
402 | Payment Required -- You need to provide billing information to perform this request.
20-
403 | Forbidden -- Quota limit exceeded. Please contact support to request a quota increase.
20+
403 | Forbidden -- Quota limit exceeded. Contact support to request a quota increase.
2121
404 | Not Found -- The requested object cannot be found.
2222
405 | Method Not Allowed -- The endpoint requested does not implement the method sent.
2323
409 | Conflict -- The object cannot be created or updated because another object exists with the same unique fields
2424
415 | Unsupported Media Type -- Make sure you are using `Accept` and `Content-Type` headers as `application/json` and that the data your are `POST`-ing or `PATCH`-ing is in valid JSON format.
2525
429 | Too Many Requests -- You are being throttled because of too many requests in a short period of time.
2626
500 | Internal Server Error -- There was a server error while processing your request. Try again later, or contact support.
27-
503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later.
28-
504 | Gateway Timeout -- Our API servers are at full capacity. Please try again later.
27+
503 | Service Unavailable -- We're temporarily offline for maintenance. Try again later.
28+
504 | Gateway Timeout -- Our API servers are at full capacity. Try again later.

apidocs/cloud-api-source/source/includes/container.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ protocol | The protocol of the port, either `tcp` or `udp`
331331
inner_port | The published port number inside the container
332332
outer_port | The published port number in the node public network interface
333333
port_name | Name of the service associated to this port
334-
uri_protocol | The protocol to be used in the endpoint for this port (i.e. `http`)
334+
uri_protocol | The protocol to be used in the endpoint for this port, such as `http`
335335
endpoint_uri | The URI of the endpoint for this port
336336
published | Whether the port has been published in the host public network interface or not. Non-published ports can only be accessed via links.
337337

apidocs/cloud-api-source/source/includes/registry.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Attribute | Description
2626
--------- | -----------
2727
resource_uri | A unique API endpoint that represents the registry
2828
name | Human-readable name of the registry
29-
host | FQDN of the registry, i.e. `registry-1.docker.io`
29+
host | FQDN of the registry, such as `registry-1.docker.io`
3030
is_docker_registry | Whether this registry is run by Docker
3131
is_ssl | Whether this registry has SSL activated or not
3232
port | The port number where the registry is listening to

apidocs/cloud-api-source/source/includes/repository.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This is a [namespaced endpoint](#namespaced-endpoints).
2222
Attribute | Description
2323
--------- | -----------
2424
resource_uri | A unique API endpoint that represents the repository
25-
name | Name of the repository, i.e. `my.registry.com/myrepo`
25+
name | Name of the repository, such as `my.registry.com/myrepo`
2626
in_use | If the image is being used by any of your services
2727
registry | Resource URI of the registry where this image is hosted
2828

@@ -123,7 +123,7 @@ Available in Docker Cloud's **REST API**
123123

124124
Parameter | Description
125125
--------- | -----------
126-
name | Name of the repository, i.e. 'my.registry.com/myrepo'
126+
name | Name of the repository, such as 'my.registry.com/myrepo'
127127
username | Username to authenticate with the third party registry
128128
password | Password to authenticate with the third party registry
129129

@@ -258,7 +258,7 @@ repository.Remove()
258258
docker-cloud repository rm registry.local/user1/image1
259259
```
260260

261-
Removes the external repository from Docker Cloud. It won't remove the repository from the third party registry where it's stored.
261+
Removes the external repository from Docker Cloud. It doesn't remove the repository from the third party registry where it's stored.
262262

263263
### Endpoint Type
264264

0 commit comments

Comments
 (0)