Skip to content

Commit

Permalink
Various copyedits to reduce future tense, wordiness, and use of 'plea…
Browse files Browse the repository at this point in the history
…se' (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
  • Loading branch information
Misty Stanley-Jones authored Jan 26, 2018
1 parent 1df7737 commit a4f5e30
Show file tree
Hide file tree
Showing 583 changed files with 3,732 additions and 4,114 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,5 +124,5 @@ know.
If you have questions about how to write for Docker's documentation, have a look
at the [style guide](https://docs.docker.com/opensource/doc-style/). The style
guide provides guidance about grammar, syntax, formatting, styling, language, or
tone. If something isn't clear in the guide, please submit an issue to let us
tone. If something isn't clear in the guide, submit an issue to let us
know or submit a pull request to help us improve it.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ We really want your feedback, and we've made it easy. You can edit, rate, or
file an issue at the bottom of every page on
[https://docs.docker.com/](https://docs.docker.com/).

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

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

## Contributing
Expand Down Expand Up @@ -158,7 +158,7 @@ You have three options:
bundle install
```
>**Note**: You may have to install some packages manually.
>**Note**: You may need to install some packages manually.
f. Change the directory to `docker.github.io`.
Expand Down
2 changes: 1 addition & 1 deletion _includes/content/compose-extfields-sub.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ x-custom:
name: "custom"
```

The contents of those fields will be ignored by Compose, but they can be
The contents of those fields are ignored by Compose, but they can be
inserted in your resource definitions using [YAML anchors](http://www.yaml.org/spec/1.2/spec.html#id2765878).
For example, if you want several of your services to use the same logging
configuration:
Expand Down
10 changes: 5 additions & 5 deletions _includes/content/compose-var-sub.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ string. In the example above, if `POSTGRES_VERSION` is not set, the value for
the `image` option is `postgres:`.

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

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

- `${VARIABLE:-default}` will evaluate to `default` if `VARIABLE` is unset or
- `${VARIABLE:-default}` evaluates to `default` if `VARIABLE` is unset or
empty in the environment.
- `${VARIABLE-default}` will evaluate to `default` only if `VARIABLE` is unset
- `${VARIABLE-default}` evaluates to `default` only if `VARIABLE` is unset
in the environment.

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

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

The VAR_NOT_INTERPOLATED_BY_COMPOSE is not set. Substituting an empty string.
2 changes: 1 addition & 1 deletion _includes/content/ssh/ssh-add-keys-to-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<div id="mac-add-keys" class="tab-pane fade in active">
<br>
{% capture mac-content-add %}
1. Start the `ssh-agent` in the background using the command `eval "$(ssh-agent -s)"`. You will get the agent process ID in return.
1. Start the `ssh-agent` in the background using the command `eval "$(ssh-agent -s)"`. You get the agent process ID in return.

```none
eval "$(ssh-agent -s)"
Expand Down
4 changes: 2 additions & 2 deletions _includes/content/ssh/ssh-find-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
$ ls -al ~/.ssh
```
This will list files in your `.ssh` directory.
This lists files in your `.ssh` directory.
2. Check to see if you already have SSH keys you can use.
Expand Down Expand Up @@ -91,7 +91,7 @@
$ ls -al ~/.ssh
```
This will list files in your `.ssh` directory.
This lists files in your `.ssh` directory.
2. Check to see if you already have a SSH keys you can use.
Expand Down
33 changes: 14 additions & 19 deletions _includes/docker_schedule_matrix.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,18 @@
{% capture green-check %}![yes](/engine/installation/images/green-check.svg){: style="height: 14px; display: inline-block"}{% endcapture %}
{% capture superscript-link %}[1](#edge-footnote){: style="vertical-align: super; font-size: smaller;" }{% endcapture %}
{: style="width: 75%" }

| Month | Docker CE Edge | Docker CE Stable |
|:----------|:----------------------------------------|:------------------|
| January | {{ green-check }} | |
| February | {{ green-check }} | |
| March | {{ green-check }}{{ superscript-link }} | {{ green-check }} |
| April | {{ green-check }} | |
| May | {{ green-check }} | |
| June | {{ green-check }}{{ superscript-link }} | {{ green-check }} |
| July | {{ green-check }} | |
| August | {{ green-check }} | |
| September | {{ green-check }}{{ superscript-link }} | {{ green-check }} |
| October | {{ green-check }} | |
| November | {{ green-check }} | |
| December | {{ green-check }}{{ superscript-link }} | {{ green-check }} |
| Month | Docker CE Edge | Docker CE Stable |
|:----------|:------------------|:------------------|
| January | {{ green-check }} | |
| February | {{ green-check }} | |
| March | {{ green-check }} | {{ green-check }} |
| April | {{ green-check }} | |
| May | {{ green-check }} | |
| June | {{ green-check }} | {{ green-check }} |
| July | {{ green-check }} | |
| August | {{ green-check }} | |
| September | {{ green-check }} | {{ green-check }} |
| October | {{ green-check }} | |
| November | {{ green-check }} | |
| December | {{ green-check }} | {{ green-check }} |

`1`: On Linux distributions, these releases will only appear in the `stable`
channels, not the `edge` channels. For that reason, on Linux distributions,
you need to enable both channels.
{: id="edge-footnote" }
10 changes: 5 additions & 5 deletions _includes/ee-linux-install-reuse.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ You can install Docker EE in different ways, depending on your needs:

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

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

If this is the first time you are installing a package from a recently added
repository, you will be prompted to accept the GPG key, and
the key's fingerprint will be shown. Verify that the fingerprint matches
repository, you are prompted to accept the GPG key, and
the key's fingerprint is shown. Verify that the fingerprint matches
`{{ gpg-fingerprint }}` and if so, accept the key.
2. On production systems, you should install a specific version of Docker EE
Expand All @@ -155,7 +155,7 @@ You can install Docker EE in different ways, depending on your needs:
```
The contents of the list depend upon which repositories you have enabled,
and will be specific to your version of {{ linux-dist-long }}
and is specific to your version of {{ linux-dist-long }}
(indicated by the `.el7` suffix on the version, in this example). Choose a
specific version to install. The second column is the version string. You
can use the entire version string, but **you need to include at least to the
Expand Down Expand Up @@ -223,7 +223,7 @@ To upgrade Docker EE:
If you cannot use the official Docker repository to install Docker EE, you can
download the `.{{ package-format | downcase }}` file for your release and
install it manually. You will need to download a new file each time you want to
install it manually. You need to download a new file each time you want to
upgrade Docker EE.
{% if linux-dist == "rhel" %}
Expand Down
12 changes: 6 additions & 6 deletions _includes/install-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ non-interactively. The source code for the scripts is in the
environments**, and you should understand the potential risks before you use
them:

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

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

sudo usermod -aG docker your-user

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

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

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

#### Upgrade Docker after using the convenience script

Expand Down
16 changes: 8 additions & 8 deletions _includes/why_d4a.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ project was created and is being actively developed to ensure that Docker users
can enjoy a fantastic out-of-the-box experience on {{cloudprovider}}. It is now
generally available and can now be used by everyone.

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

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

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

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

These self-cleaning and self-healing properties are enabled by default and don't
need configuration, so you can breathe easier as the risk of downtime is
Expand All @@ -91,7 +91,7 @@ communicating the current state of your infrastructure and the issues you are
seeing to the upstream. In Docker for {{cloudprovider}}, you receive new tools
to communicate any issues you experience quickly and securely to Docker
employees. The Docker for {{cloudprovider}} shell includes a `docker-diagnose`
script which, at your request, will transmit detailed diagnostic information to
script which, at your request, transmits detailed diagnostic information to
Docker support staff to reduce the traditional
"please-post-the-output-of-this-command" back and forth frequently encountered
in bug reports.
Expand Down
2 changes: 1 addition & 1 deletion apidocs/cloud-api-source/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ dockercloud/api-docs

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

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


## Usage
Expand Down
6 changes: 3 additions & 3 deletions apidocs/cloud-api-source/source/includes/_errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ Error Code | Meaning
400 | Bad Request -- There's a problem in the content of your request. Retrying the same request will fail.
401 | Unauthorized -- Your API key is wrong or your account has been deactivated.
402 | Payment Required -- You need to provide billing information to perform this request.
403 | Forbidden -- Quota limit exceeded. Please contact support to request a quota increase.
403 | Forbidden -- Quota limit exceeded. Contact support to request a quota increase.
404 | Not Found -- The requested object cannot be found.
405 | Method Not Allowed -- The endpoint requested does not implement the method sent.
409 | Conflict -- The object cannot be created or updated because another object exists with the same unique fields
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.
429 | Too Many Requests -- You are being throttled because of too many requests in a short period of time.
500 | Internal Server Error -- There was a server error while processing your request. Try again later, or contact support.
503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later.
504 | Gateway Timeout -- Our API servers are at full capacity. Please try again later.
503 | Service Unavailable -- We're temporarily offline for maintenance. Try again later.
504 | Gateway Timeout -- Our API servers are at full capacity. Try again later.
2 changes: 1 addition & 1 deletion apidocs/cloud-api-source/source/includes/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ protocol | The protocol of the port, either `tcp` or `udp`
inner_port | The published port number inside the container
outer_port | The published port number in the node public network interface
port_name | Name of the service associated to this port
uri_protocol | The protocol to be used in the endpoint for this port (i.e. `http`)
uri_protocol | The protocol to be used in the endpoint for this port, such as `http`
endpoint_uri | The URI of the endpoint for this port
published | Whether the port has been published in the host public network interface or not. Non-published ports can only be accessed via links.

Expand Down
2 changes: 1 addition & 1 deletion apidocs/cloud-api-source/source/includes/registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Attribute | Description
--------- | -----------
resource_uri | A unique API endpoint that represents the registry
name | Human-readable name of the registry
host | FQDN of the registry, i.e. `registry-1.docker.io`
host | FQDN of the registry, such as `registry-1.docker.io`
is_docker_registry | Whether this registry is run by Docker
is_ssl | Whether this registry has SSL activated or not
port | The port number where the registry is listening to
Expand Down
6 changes: 3 additions & 3 deletions apidocs/cloud-api-source/source/includes/repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This is a [namespaced endpoint](#namespaced-endpoints).
Attribute | Description
--------- | -----------
resource_uri | A unique API endpoint that represents the repository
name | Name of the repository, i.e. `my.registry.com/myrepo`
name | Name of the repository, such as `my.registry.com/myrepo`
in_use | If the image is being used by any of your services
registry | Resource URI of the registry where this image is hosted

Expand Down Expand Up @@ -123,7 +123,7 @@ Available in Docker Cloud's **REST API**

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

Expand Down Expand Up @@ -258,7 +258,7 @@ repository.Remove()
docker-cloud repository rm registry.local/user1/image1
```

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

### Endpoint Type

Expand Down
Loading

0 comments on commit a4f5e30

Please sign in to comment.