Update the styleguide (#2332)

* Update the styleguide

Also normalize admonition titles with the colon outside the bold.
This commit is contained in:
Misty Stanley-Jones 2017-03-15 09:46:30 -07:00 committed by GitHub
parent 9e244bbb9c
commit fb7c73908b
63 changed files with 186 additions and 144 deletions

View File

@ -208,7 +208,7 @@ A service has the following fields:
</dd>
</dl>
> **Note:** Some configuration options are not yet supported in the DAB format,
> **Note**: Some configuration options are not yet supported in the DAB format,
> including volume mounts.
## Related topics

View File

@ -21,7 +21,7 @@ The Version 1 Compose file is a [YAML](http://yaml.org/) file that defines [serv
The default path for a Compose file is `./docker-compose.yml`.
>**Tip:** You can use either a `.yml` or `.yaml` extension for this file. They both work.
>**Tip**: You can use either a `.yml` or `.yaml` extension for this file. They both work.
A service definition contains configuration which will be applied to each
container started for that service, much like passing command-line parameters to
@ -79,7 +79,7 @@ See `man 7 capabilities` for a full list.
- NET_ADMIN
- SYS_ADMIN
> **Note:** These options are ignored when
> **Note**: These options are ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file.
@ -153,7 +153,7 @@ The entrypoint can also be a list, in a manner similar to
- memory_limit=-1
- vendor/bin/phpunit
> **Note:** Setting `entrypoint` will both override any default entrypoint set
> **Note**: Setting `entrypoint` will both override any default entrypoint set
> on the service's image with the `ENTRYPOINT` Dockerfile instruction, *and*
> clear out any default command on the image - meaning that if there's a `CMD`
> instruction in the Dockerfile, it will be ignored.
@ -180,7 +180,7 @@ beginning with `#` (i.e. comments) are ignored, as are blank lines.
# Set Rails/Rack environment
RACK_ENV=development
> **Note:** If your service specifies a [build](#build) option, variables
> **Note**: If your service specifies a [build](#build) option, variables
> defined in environment files will _not_ be automatically visible during the
> build.
@ -207,7 +207,7 @@ machine Compose is running on, which can be helpful for secret or host-specific
- SHOW=true
- SESSION_SECRET
> **Note:** If your service specifies a [build](#build) option, variables
> **Note**: If your service specifies a [build](#build) option, variables
> defined in `environment` will _not_ be automatically visible during the
> build.
@ -325,7 +325,7 @@ the alias, or the service name if no alias was specified.
Links also express dependency between services in the same way as
[depends_on](#dependson), so they determine the order of service startup.
> **Note:** If you define both links and [networks](#networks), services with
> **Note**: If you define both links and [networks](#networks), services with
> links between them must share at least one network in common in order to
> communicate.
@ -376,7 +376,7 @@ containers in the bare-metal machine's namespace and vise-versa.
Expose ports. Either specify both ports (`HOST:CONTAINER`), or just the container
port (a random host port will be chosen).
> **Note:** When mapping ports in the `HOST:CONTAINER` format, you may experience
> **Note**: When mapping ports in the `HOST:CONTAINER` format, you may experience
> erroneous results when using a container port lower than 60, because YAML will
> parse numbers in the format `xx:yy` as sexagesimal (base 60). For this reason,
> we recommend always explicitly specifying your port mappings as strings.

View File

@ -22,7 +22,7 @@ The Compose file is a [YAML](http://yaml.org/) file defining
[volumes](#volume-configuration-reference).
The default path for a Compose file is `./docker-compose.yml`.
>**Tip:** You can use either a `.yml` or `.yaml` extension for this file. They both work.
>**Tip**: You can use either a `.yml` or `.yaml` extension for this file. They both work.
A [container](/engine/reference/glossary.md#container) definition contains configuration which will be applied to each
container started for that service, much like passing command-line parameters to
@ -205,7 +205,7 @@ Simple example:
db:
image: postgres
> **Note:** `depends_on` will not wait for `db` and `redis` to be "ready" before
> **Note**: `depends_on` will not wait for `db` and `redis` to be "ready" before
> starting `web` - only until they have been started. If you need to wait
> for a service to be ready, see [Controlling startup order](startup-order.md)
> for more on this problem and strategies for solving it.
@ -287,7 +287,7 @@ The entrypoint can also be a list, in a manner similar to
- memory_limit=-1
- vendor/bin/phpunit
> **Note:** Setting `entrypoint` will both override any default entrypoint set
> **Note**: Setting `entrypoint` will both override any default entrypoint set
> on the service's image with the `ENTRYPOINT` Dockerfile instruction, *and*
> clear out any default command on the image - meaning that if there's a `CMD`
> instruction in the Dockerfile, it will be ignored.
@ -314,7 +314,7 @@ beginning with `#` (i.e. comments) are ignored, as are blank lines.
# Set Rails/Rack environment
RACK_ENV=development
> **Note:** If your service specifies a [build](#build) option, variables
> **Note**: If your service specifies a [build](#build) option, variables
> defined in environment files will _not_ be automatically visible during the
> build. Use the [args](#args) sub-option of `build` to define build-time
> environment variables.
@ -342,7 +342,7 @@ machine Compose is running on, which can be helpful for secret or host-specific
- SHOW=true
- SESSION_SECRET
> **Note:** If your service specifies a [build](#build) option, variables
> **Note**: If your service specifies a [build](#build) option, variables
> defined in `environment` will _not_ be automatically visible during the
> build. Use the [args](#args) sub-option of `build` to define build-time
> environment variables.
@ -397,7 +397,7 @@ container name and the link alias (`CONTAINER:ALIAS`).
- project_db_1:mysql
- project_db_1:postgresql
> **Note:** For version 2 file format, the
> **Note**: For version 2 file format, the
> externally-created containers must be connected to at least one of the same
> networks as the service which is linking to them.
@ -532,7 +532,7 @@ the alias, or the service name if no alias was specified.
Links also express dependency between services in the same way as
[depends_on](#dependson), so they determine the order of service startup.
> **Note:** If you define both links and [networks](#networks), services with
> **Note**: If you define both links and [networks](#networks), services with
> links between them must share at least one network in common in order to
> communicate. We recommend using networks instead.
@ -558,7 +558,7 @@ The default value is json-file.
driver: "syslog"
driver: "none"
> **Note:** Only the `json-file` and `journald` drivers make the logs available directly from
> **Note**: Only the `json-file` and `journald` drivers make the logs available directly from
> `docker-compose up` and `docker-compose logs`. Using any other driver will not
> print any logs.
@ -726,7 +726,7 @@ containers in the bare-metal machine's namespace and vise-versa.
Expose ports. Either specify both ports (`HOST:CONTAINER`), or just the container
port (a random host port will be chosen).
> **Note:** When mapping ports in the `HOST:CONTAINER` format, you may experience
> **Note**: When mapping ports in the `HOST:CONTAINER` format, you may experience
> erroneous results when using a container port lower than 60, because YAML will
> parse numbers in the format `xx:yy` as sexagesimal (base 60). For this reason,
> we recommend always explicitly specifying your port mappings as strings.
@ -874,7 +874,7 @@ then read-write will be used.
- container:container_name
- container:container_name:rw
> **Note:** The `container:...` formats are only supported in the
> **Note**: The `container:...` formats are only supported in the
> [version 2 file format](#version-2). In [version 1](compose-versioning.md#version-1), you can use
> container names without marking them as such:
>

View File

@ -41,7 +41,7 @@ The [Compatibility Matrix](#compatibility-matrix) shows Compose file versions ma
To move your project to a later version, see the [Upgrading](#upgrading)
section.
> **Note:** If you're using
> **Note**: If you're using
> [multiple Compose files](extends.md#different-environments) or
> [extending services](extends.md#extending-services), each file must be of the
> same version - you cannot, for example, mix version 1 and 2 in a single

View File

@ -24,7 +24,7 @@ The Compose file is a [YAML](http://yaml.org/) file defining
[volumes](#volume-configuration-reference).
The default path for a Compose file is `./docker-compose.yml`.
>**Tip:** You can use either a `.yml` or `.yaml` extension for this file. They both work.
>**Tip**: You can use either a `.yml` or `.yaml` extension for this file. They both work.
A service definition contains configuration which will be applied to each
container started for that service, much like passing command-line parameters to
@ -66,7 +66,7 @@ with the `webapp` and optional `tag` specified in `image`:
This will result in an image named `webapp` and tagged `tag`, built from `./dir`.
> **Note:** This option is ignored when
> **Note**: This option is ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file. The `docker stack` command accepts only pre-built images.
@ -144,7 +144,7 @@ See `man 7 capabilities` for a full list.
- NET_ADMIN
- SYS_ADMIN
> **Note:** These options are ignored when
> **Note**: These options are ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file.
@ -165,7 +165,7 @@ Specify an optional parent cgroup for the container.
cgroup_parent: m-executor-abcd
> **Note:** This option is ignored when
> **Note**: This option is ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file.
@ -314,7 +314,7 @@ client create option.
devices:
- "/dev/ttyUSB0:/dev/ttyUSB0"
> **Note:** This option is ignored when
> **Note**: This option is ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file.
@ -343,7 +343,7 @@ Simple example:
db:
image: postgres
> **Note:** There are several things to be aware of when using `depends_on`:
> **Note**: There are several things to be aware of when using `depends_on`:
>
> - `depends_on` will not wait for `db` and `redis` to be "ready" before
> starting `web` - only until they have been started. If you need to wait
@ -366,7 +366,7 @@ Custom DNS servers. Can be a single value or a list.
- 8.8.8.8
- 9.9.9.9
> **Note:** This option is ignored when
> **Note**: This option is ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file.
@ -379,7 +379,7 @@ Custom DNS search domains. Can be a single value or a list.
- dc1.example.com
- dc2.example.com
> **Note:** This option is ignored when
> **Note**: This option is ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file.
@ -394,7 +394,7 @@ Mount a temporary file system inside the container. Can be a single value or a l
- /run
- /tmp
> **Note:** This option is ignored when
> **Note**: This option is ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file.
@ -415,7 +415,7 @@ The entrypoint can also be a list, in a manner similar to
- memory_limit=-1
- vendor/bin/phpunit
> **Note:** Setting `entrypoint` will both override any default entrypoint set
> **Note**: Setting `entrypoint` will both override any default entrypoint set
> on the service's image with the `ENTRYPOINT` Dockerfile instruction, *and*
> clear out any default command on the image - meaning that if there's a `CMD`
> instruction in the Dockerfile, it will be ignored.
@ -442,7 +442,7 @@ beginning with `#` (i.e. comments) are ignored, as are blank lines.
# Set Rails/Rack environment
RACK_ENV=development
> **Note:** If your service specifies a [build](#build) option, variables
> **Note**: If your service specifies a [build](#build) option, variables
> defined in environment files will _not_ be automatically visible during the
> build. Use the [args](#args) sub-option of `build` to define build-time
> environment variables.
@ -470,7 +470,7 @@ machine Compose is running on, which can be helpful for secret or host-specific
- SHOW=true
- SESSION_SECRET
> **Note:** If your service specifies a [build](#build) option, variables
> **Note**: If your service specifies a [build](#build) option, variables
> defined in `environment` will _not_ be automatically visible during the
> build. Use the [args](#args) sub-option of `build` to define build-time
> environment variables.
@ -664,7 +664,7 @@ The default value is json-file.
driver: "syslog"
driver: "none"
> **Note:** Only the `json-file` and `journald` drivers make the logs available directly from
> **Note**: Only the `json-file` and `journald` drivers make the logs available directly from
> `docker-compose up` and `docker-compose logs`. Using any other driver will not
> print any logs.
@ -687,7 +687,7 @@ the special form `service:[service name]`.
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"
> **Note:** This option is ignored when
> **Note**: This option is ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file.
@ -820,7 +820,7 @@ containers in the bare-metal machine's namespace and vise-versa.
Expose ports. Either specify both ports (`HOST:CONTAINER`), or just the container
port (a random host port will be chosen).
> **Note:** When mapping ports in the `HOST:CONTAINER` format, you may experience
> **Note**: When mapping ports in the `HOST:CONTAINER` format, you may experience
> erroneous results when using a container port lower than 60, because YAML will
> parse numbers in the format `xx:yy` as sexagesimal (base 60). For this reason,
> we recommend always explicitly specifying your port mappings as strings.
@ -939,7 +939,7 @@ Override the default labeling scheme for each container.
- label:user:USER
- label:role:ROLE
> **Note:** This option is ignored when
> **Note**: This option is ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file.
@ -964,7 +964,7 @@ SIGTERM. Setting an alternative signal using `stop_signal` will cause
stop_signal: SIGUSR1
> **Note:** This option is ignored when
> **Note**: This option is ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file.
@ -981,7 +981,7 @@ dictionary.
- net.core.somaxconn=1024
- net.ipv4.tcp_syncookies=0
> **Note:** This option is ignored when
> **Note**: This option is ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file.
@ -1005,13 +1005,13 @@ Disables the user namespace for this service, if Docker daemon is configured wit
See [dockerd](/engine/reference/commandline/dockerd.md#disable-user-namespace-for-a-container) for
more information.
> **Note:** This option is ignored when
> **Note**: This option is ignored when
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
> with a (version 3) Compose file.
### volumes, volume\_driver
> **Note:** The top-level
> **Note**: The top-level
> [`volumes` option](#volume-configuration-reference) defines
> a named volume and references it from each service's `volumes` list. This replaces `volumes_from` in earlier versions of the Compose file format.

View File

@ -35,7 +35,7 @@ variables](reference/envvars.md):
- `DOCKER_HOST`
- `DOCKER_TLS_VERIFY`
> **Note:** Values present in the environment at runtime will always override
> **Note**: Values present in the environment at runtime will always override
> those defined inside the `.env` file. Similarly, values passed via
> command-line arguments take precedence as well.

View File

@ -167,7 +167,7 @@ is useful if you have several services that reuse a common set of configuration
options. Using `extends` you can define a common set of service options in one
place and refer to it from anywhere.
> **Note:** `links`, `volumes_from`, and `depends_on` are never shared between
> **Note**: `links`, `volumes_from`, and `depends_on` are never shared between
> services using `extends`. These exceptions exist to avoid
> implicit dependencies&mdash;you always define `links` and `volumes_from`
> locally. This ensures dependencies between services are clearly visible when
@ -284,7 +284,7 @@ replaces the old value.
# result
command: python otherapp.py
> **Note:** In the case of `build` and `image`, when using
> **Note**: In the case of `build` and `image`, when using
> [version 1 of the Compose file format](compose-file.md#version-1), using one
> option in the local service causes Compose to discard the other option if it
> was defined in the original service.

View File

@ -103,7 +103,7 @@ The `redis` service uses a public
[Redis](https://registry.hub.docker.com/_/redis/) image pulled from the Docker
Hub registry.
>**Tip:** If your project is outside of the `Users` directory (`cd ~`), then you
>**Tip**: If your project is outside of the `Users` directory (`cd ~`), then you
need to share the drive or location of the Dockerfile and volume you are using.
If you get runtime errors indicating an application file is not found, a volume
mount is denied, or a service cannot start, try enabling file or drive sharing.
@ -151,7 +151,7 @@ containers](../engine/tutorials/dockervolumes.md).
The number should increment.
>**Tip:** You can list local images with `docker image ls` and inspect them with `docker inspect <tag or id>`. Listing images at this point should return `redis` and `web`.
>**Tip**: You can list local images with `docker image ls` and inspect them with `docker inspect <tag or id>`. Listing images at this point should return `redis` and `web`.
## Step 5: Update the application

View File

@ -72,7 +72,7 @@ to get started.
$ pip install docker-compose
```
> **Note:** pip version 6.0 or greater is required
> **Note**: pip version 6.0 or greater is required
### Install as a container

View File

@ -7,7 +7,7 @@ title: Link environment variables (superseded)
notoc: true
---
> **Note:** Environment variables are no longer the recommended method for connecting to linked services. Instead, you should use the link name (by default, the name of the linked service) as the hostname to connect to. See the [docker-compose.yml documentation](compose-file.md#links) for details.
> **Note**: Environment variables are no longer the recommended method for connecting to linked services. Instead, you should use the link name (by default, the name of the linked service) as the hostname to connect to. See the [docker-compose.yml documentation](compose-file.md#links) for details.
>
> Environment variables will only be populated if you're using the [legacy version 1 Compose file format](compose-file.md#versioning).

View File

@ -4,7 +4,7 @@ keywords: documentation, docs, docker, compose, orchestration, containers, netwo
title: Networking in Compose
---
> **Note:** This document only applies if you're using [version 2 or higher of the Compose file format](compose-file.md#versioning). Networking features are not supported for version 1 (legacy) Compose files.
> **Note**: This document only applies if you're using [version 2 or higher of the Compose file format](compose-file.md#versioning). Networking features are not supported for version 1 (legacy) Compose files.
By default Compose sets up a single
[network](/engine/reference/commandline/network_create/) for your app. Each
@ -12,7 +12,7 @@ container for a service joins the default network and is both *reachable* by
other containers on that network, and *discoverable* by them at a hostname
identical to the container name.
> **Note:** Your app's network is given a name based on the "project name",
> **Note**: Your app's network is given a name based on the "project name",
> which is based on the name of the directory it lives in. You can override the
> project name with either the [`--project-name`
> flag](reference/overview.md) or the [`COMPOSE_PROJECT_NAME` environment

View File

@ -56,7 +56,7 @@ to link them together and expose the web app's port.
depends_on:
- db
>**Tip:** You can use either a `.yml` or `.yaml` extension for this file.
>**Tip**: You can use either a `.yml` or `.yaml` extension for this file.
### Build the project

View File

@ -15,7 +15,7 @@ Numbers are specified as arguments in the form `service=num`. For example:
docker-compose scale web=2 worker=3
>**Tip:** Alternatively, in
>**Tip**: Alternatively, in
[Compose file version 3.x](/compose/compose-file/index.md), you can specify
[`replicas`](/compose/compose-file/index.md#replicas)
under [`deploy`](/compose/compose-file/index.md#deploy) as part of the

View File

@ -47,7 +47,7 @@ script:
db:
image: postgres
>**Tip:** There are limitations to this first solution; e.g., it doesn't verify when a specific service is really ready. If you add more arguments to the command, you'll need to use the `bash shift` command with a loop, as shown in the next example.
>**Tip**: There are limitations to this first solution; e.g., it doesn't verify when a specific service is really ready. If you add more arguments to the command, you'll need to use the `bash shift` command with a loop, as shown in the next example.
- Alternatively, write your own wrapper script to perform a more application-specific health
check. For example, you might want to wait until Postgres is definitely

View File

@ -18,7 +18,7 @@ Compose to set up and run WordPress. Before starting, you'll need to have
This project directory will contain a `docker-compose.yml` file which will
be complete in itself for a good starter wordpress project.
>**Tip:** You can use either a `.yml` or `.yaml` extension for this file. They both work.
>**Tip**: You can use either a `.yml` or `.yaml` extension for this file. They both work.
2. Change directories into your project directory.

View File

@ -48,7 +48,7 @@ to update its RHEL kernel.
$ sudo rpm --import "https://sks-keyservers.net/pks/lookup?op=get&search=0xee6d536cf7dc86e2d7d56f59a178ac6c6238f52e"
```
> **Note:** If the key server above does not respond, you can try one of these:
> **Note**: If the key server above does not respond, you can try one of these:
>
> - pgp.mit.edu
> - keyserver.ubuntu.com
@ -156,7 +156,7 @@ to update its RHEL kernel.
$ curl -fsSL 'https://sks-keyservers.net/pks/lookup?op=get&search=0xee6d536cf7dc86e2d7d56f59a178ac6c6238f52e' | sudo apt-key add -
```
> **Note:** If the key server above does not respond, you can try one of these:
> **Note**: If the key server above does not respond, you can try one of these:
>
> - pgp.mit.edu
> - keyserver.ubuntu.com
@ -237,7 +237,7 @@ to update its RHEL kernel.
This adds the repository of the latest version of CS Docker Engine. You can
customize the URL to install an older version.
> **Note:** If the key server above does not respond, you can try one of these:
> **Note**: If the key server above does not respond, you can try one of these:
>
> - pgp.mit.edu
> - keyserver.ubuntu.com

View File

@ -10,7 +10,7 @@ Docker Cloud's **Autoredeploy** feature allows a service that uses an image
stored in Docker Hub to automatically redeploy whenever a new image is pushed or
built.
> **Note:** To enable autoredeploy on an image stored in a third party registry,
> **Note**: To enable autoredeploy on an image stored in a third party registry,
> you will need to use [redeploy triggers](triggers.md) instead.

View File

@ -12,7 +12,7 @@ Docker Cloud now allows you to connect to clusters of Docker Engines running in
The current release of Docker Cloud automatically opts in new users to Beta
Swarm Mode.
> **Note:** All Swarm management features in Docker Cloud are free while in Beta.
> **Note**: All Swarm management features in Docker Cloud are free while in Beta.
### New to Docker Cloud?

View File

@ -58,7 +58,7 @@ Once Homebrew is installed, open Terminal and run the following command:
$ brew install docker-cloud
```
> **Note:** You can also use [pip](https://pip.pypa.io/en/stable/) to install on macOS, but we suggest Homebrew since it is a package manager designed for the Mac.
> **Note**: You can also use [pip](https://pip.pypa.io/en/stable/) to install on macOS, but we suggest Homebrew since it is a package manager designed for the Mac.
## Validate the CLI installation
Check that the CLI installed correctly, using the `docker-cloud -v` command. (This command is the same for every platform.)

View File

@ -69,7 +69,7 @@ Once Homebrew is installed, open Terminal and run the following command:
$ brew install docker-cloud
```
> **Note:** You can also use [pip](https://pip.pypa.io/en/stable/) to install on macOS, but we suggest Homebrew since it is a package manager designed for the
> **Note**: You can also use [pip](https://pip.pypa.io/en/stable/) to install on macOS, but we suggest Homebrew since it is a package manager designed for the
Mac.
#### Validate the installation

View File

@ -14,5 +14,5 @@ nodes, services, and applications in Docker Cloud.
* [Cloud stack file YAML reference](/docker-cloud/apps/stack-yaml-reference.md)
> **Note:** These workflows and references do not apply
> **Note**: These workflows and references do not apply
to [Swarm Mode](/docker-cloud/cloud-swarm/index.md) Beta.

View File

@ -67,7 +67,7 @@ docker-machine version 0.10.0, build 76ed2a6
![nginx home page](images/hello-world-nginx.png)
> **Note:** Early beta releases used `docker` as the hostname to build the
> **Note**: Early beta releases used `docker` as the hostname to build the
> URL. Now, ports are exposed on the private IP addresses of the VM and
> forwarded to `localhost` with no other host name set. See also,
> [Release Notes](release-notes.md) for Beta 9.
@ -150,7 +150,7 @@ want to add.
See [Namespaces](osxfs.md#namespaces) in the topic on
[osxfs file system sharing](osxfs.md) for more information.
> **Tip:** File sharing is required for volume mounting if the project lives
> **Tip**: File sharing is required for volume mounting if the project lives
> outside of the `/Users` directory. In that case, share the drive where the
> Dockerfile and volume are located. Otherwise, you will get file not found or
> cannot start service errors at runtime. (See also

View File

@ -183,7 +183,7 @@ To fix existing containers, follow these steps.
3. Start Docker.
> **Note:** Be sure to quit and then restart Docker for Mac before attempting to start containers.
> **Note**: Be sure to quit and then restart Docker for Mac before attempting to start containers.
4. Try to start the container again:

View File

@ -129,7 +129,7 @@ The next few steps take you through some examples. These are just suggestions fo
Live Restore Enabled: false
```
>**Note:** The outputs above are examples. Your output for commands like
>**Note**: The outputs above are examples. Your output for commands like
> `docker version` and `docker info` will vary depending on your product
> versions (e.g., as you install newer versions).
@ -298,7 +298,7 @@ When Docker is running, the Docker whale is displayed. By default, the Docker
whale icon is placed in the Notifications area. If it is hidden, click the up
arrow on the taskbar to show it.
>**Tip:** You can pin the whale outside of the notification box so that it is
>**Tip**: You can pin the whale outside of the notification box so that it is
always visible on the taskbar. To do this, drag-and-drop the whale icon. Or,
right-click an empty porition of the taskbar, select Settings, and choose
display options through taskbar settings for notifications.
@ -354,7 +354,7 @@ here. If you run `docker` commands and tasks under a different username than the
one used here to set up sharing, your containers will not have permissions to
access the mounted volumes.
> **Tip:** Shared drives are only required for volume mounting
> **Tip**: Shared drives are only required for volume mounting
> [Linux containers](#switch-between-windows-and-linux-containers), and not for
> Windows containers. For Linux containers, you need to share the drive where
> your project is located (i.e., where the Dockerfile and volume are located).
@ -366,7 +366,7 @@ See also
[Verify domain user has permissions for shared drives](troubleshoot.md#verify-domain-user-has-permissions-for-shared-drives-volumes)
in Troubleshooting.
> **Note:** You can share local drives with your _containers_ but not with
> **Note**: You can share local drives with your _containers_ but not with
> Docker Machine nodes. See
> [Can I share local drives and filesystem with my Docker Machine VMs?](faqs.md#can-i-share-local-drives-and-filesystem-with-my-docker-machine-vms)
> in the FAQs.
@ -407,7 +407,7 @@ You can configure Docker for Windows networking to work on a virtual private net
![Network settings](/docker-for-windows/images/settings-network.png)
> **Note:** Some users reported problems connecting to Docker Hub on Docker for
> **Note**: Some users reported problems connecting to Docker Hub on Docker for
> Windows stable version. This would manifest as an error when trying to run
> `docker` commands that pull images from Docker Hub that are not already
> downloaded, such as a first time run of `docker run hello-world`. If you

View File

@ -71,7 +71,7 @@ Drives** and share the drive that contains the Dockerfile and volume.
### Verify domain user has permissions for shared drives (volumes)
>**Tip:** Shared drives are only required for volume mounting [Linux
>**Tip**: Shared drives are only required for volume mounting [Linux
containers](index.md#switch-between-windows-and-linux-containers),
not Windows containers.
@ -211,7 +211,7 @@ To fix existing containers, follow these steps.
3. Start Docker.
> **Note:** Be sure to quit and then restart Docker for Windows before attempting to start containers.
> **Note**: Be sure to quit and then restart Docker for Windows before attempting to start containers.
4. Try to start the container again:

View File

@ -79,7 +79,7 @@ to building your applications and services.
With Official Repositories you know you're using an optimized and
up-to-date image that was built by experts to power your applications.
> **Note:** If you would like to contribute an Official Repository for your
> **Note**: If you would like to contribute an Official Repository for your
> organization or product, see the documentation on
> [Official Repositories on Docker Hub](/docker-hub/official_repos.md) for more
> information.

View File

@ -124,7 +124,7 @@ designated, they can `push` and `pull` to your repositories. They will not be
allowed to perform any administrative tasks such as deleting the repository or
changing its status from private to public.
> **Note:**
> **Note**:
> A collaborator cannot add other collaborators. Only the owner of
> the repository has administrative access.
@ -209,7 +209,7 @@ payload similar to the example shown below.
<!-- TODO: does it tell you what tag was updated? -->
>**Note:** If you want to test your webhook, we recommend using a tool like
>**Note**: If you want to test your webhook, we recommend using a tool like
>[requestb.in](http://requestb.in/). Also note, the Docker Hub server can't be
>filtered by IP address.

View File

@ -44,6 +44,6 @@ example webhook below generates an HTTP POST that delivers a JSON payload:
}
```
>**Note:** If you want to test your webhook, we recommend using a tool like
>**Note**: If you want to test your webhook, we recommend using a tool like
>[requestb.in](http://requestb.in/). Also note, the Docker Hub server can't be
>filtered by IP address.

View File

@ -47,7 +47,7 @@ For Docker Cloud, Hub, and Store, log in using the web interface.
You can also log in using the `docker login` command. (You can read more about `docker login` [here](/engine/reference/commandline/login.md).)
> **Warning:** When you use the `docker login` command, your credentials are
> **Warning**: When you use the `docker login` command, your credentials are
stored in your home directory in `.docker/config.json`. The password is base64
encoded in this file. If you require secure storage for this password, use the
[Docker credential helpers](https://github.com/docker/docker-credential-helpers).

View File

@ -102,7 +102,7 @@ as a bootable ISO, is a free download, and works well with VirtualBox.
Once you've downloaded the tool, add the ISO to the Boot2Docker VM IDE bus.
You might need to create the bus before you can add the ISO.
> **Note:**
> **Note**:
> It's important that you choose a partitioning tool that is available as an ISO so
> that the Boot2Docker VM can be booted with it.

View File

@ -72,7 +72,7 @@ send this signal is using the `kill` command on Linux systems. For example,
`kill -USR1 <daemon-pid>` sends the `SIGUSR1` signal to the daemon process,
causing the stack dump to be added to the daemon log.
> **Note:** The log level setting of the daemon must be at least "info" level and above for
> **Note**: The log level setting of the daemon must be at least "info" level and above for
the stack trace to be saved to the logfile. By default the daemon's log level is set to
"info".

View File

@ -53,7 +53,7 @@ To configure which
should be used, you can specify the `awslogs-stream` log option. If not
specified, the container ID is used as the log stream.
> **Note:**
> **Note**:
> Log streams within a given log group should only be used by one container
> at a time. Using the same log stream for multiple containers concurrently
> can cause reduced logging performance.

View File

@ -56,6 +56,6 @@ Here is an example event message:
A client can parse this message string to get both the log message, as well as its
context information. Note that the time stamp is also available within the ETW event.
> **Note:** This ETW provider emits only a message string, and not a specially
> **Note**: This ETW provider emits only a message string, and not a specially
> structured ETW event. Therefore, it is not required to register a manifest file
> with the system to read and interpret its ETW events.

View File

@ -10,7 +10,7 @@ In this example, we are going to learn how to build a Docker image with
MongoDB pre-installed. We'll also see how to `push` that image to the
[Docker Hub registry](https://hub.docker.com) and share it with others!
> **Note:** This guide will show the mechanics of building a MongoDB container, but
> **Note**: This guide will show the mechanics of building a MongoDB container, but
you will probably want to use the official image on [Docker Hub]( https://hub.docker.com/_/mongo/)
Using Docker and containers for deploying [MongoDB](https://www.mongodb.org/)
@ -20,7 +20,7 @@ instances will bring several benefits, such as:
- Ready to run and start working within milliseconds;
- Based on globally accessible and shareable images.
> **Note:** If you do **_not_** like `sudo`, you might want to check out
> **Note**: If you do **_not_** like `sudo`, you might want to check out
[*Giving non-root access*](../installation/binaries.md#giving-non-root-access).
## Creating a Dockerfile for MongoDB
@ -40,7 +40,7 @@ Although optional, it is handy to have comments at the beginning of a
# http://docs.mongodb.org/manual/tutorial/install-mongodb-on-ubuntu/
```
> **Tip:** `Dockerfile`s are flexible. However, they need to follow a certain
> **Tip**: `Dockerfile`s are flexible. However, they need to follow a certain
format. The first item to be defined is the name of an image, which becomes
the *parent* of your *Dockerized MongoDB* image.
@ -52,7 +52,7 @@ We will build our image using the latest version of Ubuntu from the
FROM ubuntu:latest
```
> **Note:** Although Ubuntu systems have MongoDB packages, they are likely to
> **Note**: Although Ubuntu systems have MongoDB packages, they are likely to
> be outdated. Therefore in this example, we will use the official MongoDB
> packages.
@ -73,7 +73,7 @@ After this initial preparation we can update our packages and install MongoDB.
RUN apt-get update && apt-get install -y mongodb-org
```
> **Tip:** You can install a specific version of MongoDB by using a list of required packages with versions, e.g.:
> **Tip**: You can install a specific version of MongoDB by using a list of required packages with versions, e.g.:
```dockerfile
RUN apt-get update && apt-get install -y mongodb-org=3.0.1 mongodb-org-server=3.0.1 mongodb-org-shell=3.0.1 mongodb-org-mongos=3.0.1 mongodb-org-tools=3.0.1
```
@ -100,7 +100,7 @@ ENTRYPOINT ["/usr/bin/mongod"]
Now save the file and let's build our image.
> **Note:** The full version of this `Dockerfile` can be found [here](https://github.com/docker/docker.github.io/blob/master/engine/examples/mongodb/Dockerfile).
> **Note**: The full version of this `Dockerfile` can be found [here](https://github.com/docker/docker.github.io/blob/master/engine/examples/mongodb/Dockerfile).
## Building the MongoDB Docker image
@ -168,7 +168,7 @@ $ mongo --port 27017
$ mongo --port 27017 --host 192.168.59.103
```
> **Tip:** If you want to run two containers on the same engine, then you will need to map
> **Tip**: If you want to run two containers on the same engine, then you will need to map
the exposed port to two different ports on the host
```bash

View File

@ -60,7 +60,7 @@ Now, we'll add our Docker machines to a [swarm](/engine/swarm/index.md).
To add a manager to this swarm, run 'docker swarm join-token manager' and follow the instructions.
```
>**Tip:** The next step is to log into the worker machine. You can either open a new shell, or exit out of the manager in the current shell by typing `exit`.
>**Tip**: The next step is to log into the worker machine. You can either open a new shell, or exit out of the manager in the current shell by typing `exit`.
### Add a worker node to the swarm

View File

@ -15,7 +15,7 @@ The `docker-stack.yml` file must be located on a manager for the swarm where you
Copy-and-paste the contents of that file into a file of the same name on your host.
>**Tip:** To avoid text encoding errors from a direct file download, especially on Windows, create the file directly in a Linux environment on your local machine and copy-paste the raw text from the original `docker-stack.yml`. A file downloaded on a Windows system might include `^M` line endings, which will prevent the app from running in the Docker Linux based environment.
>**Tip**: To avoid text encoding errors from a direct file download, especially on Windows, create the file directly in a Linux environment on your local machine and copy-paste the raw text from the original `docker-stack.yml`. A file downloaded on a Windows system might include `^M` line endings, which will prevent the app from running in the Docker Linux based environment.
2. Copy `docker-stack.yml` from your host machine onto the manager.

View File

@ -135,7 +135,7 @@ locally.
$ docker rmi -f 7d9495d03763
```
>**Tip:** You can also remove an image with `docker image rm -f` followed by image ID or name in a similar fashion.
>**Tip**: You can also remove an image with `docker image rm -f` followed by image ID or name in a similar fashion.
4. When you use `docker run` it automatically downloads (pulls) images that
don't yet exist locally, creates a container, and starts it. Use the

View File

@ -15,7 +15,7 @@ this profile in `tmpfs` and then loads it into the kernel. On Docker versions
earlier than `1.13.0`, this profile is generated in `/etc/apparmor.d/docker`
instead.
> **Note:** This profile is used on containers, _not_ on the Docker Daemon.
> **Note**: This profile is used on containers, _not_ on the Docker Daemon.
A profile for the Docker Engine daemon exists but it is not currently installed
with the `deb` packages. If you are interested in the source for the daemon
@ -221,7 +221,7 @@ looks like the following:
In the above example, you can see `profile=/usr/bin/docker`. This means the
user has the `docker-engine` (Docker Engine Daemon) profile loaded.
> **Note:** On version of Ubuntu > 14.04 this is all fine and well, but Trusty
> **Note**: On version of Ubuntu > 14.04 this is all fine and well, but Trusty
> users might run into some issues when trying to `docker exec`.
Look at another log line:

View File

@ -21,7 +21,7 @@ A custom certificate is configured by creating a directory under
`/etc/docker/certs.d` using the same name as the registry's hostname (e.g.,
`localhost`). All `*.crt` files are added to this directory as CA roots.
> **Note:**
> **Note**:
> As of docker 1.13, on Linux any root certificates authorities will be merged
> in with the system defaults (i.e., host's root CA set). Prior to 1.13 and on
> Windows, the system default certificates will only be used when there are no
@ -31,7 +31,7 @@ The presence of one or more `<filename>.key/cert` pairs indicates to Docker
that there are custom certificates required for access to the desired
repository.
> **Note:**
> **Note**:
> If there are multiple certificates, each will be tried in alphabetical
> order. If there is an authentication error (e.g., 403, 404, 5xx, etc.), Docker
> will continue to try with the next certificate.
@ -60,7 +60,7 @@ key and then use the key to create the certificate.
$ openssl genrsa -out client.key 4096
$ openssl req -new -x509 -text -key client.key -out client.cert
> **Note:**
> **Note**:
> These TLS commands will only generate a working set of certificates on Linux.
> The version of OpenSSL in macOS is incompatible with the type of
> certificate Docker requires.

View File

@ -29,7 +29,7 @@ Delegation keys are optional, and not generated as part of the normal `docker`
workflow. They need to be
[manually generated and added to the repository](trust_delegation.md#generating-delegation-keys).
**Note:** Prior to Docker Engine 1.11, the snapshot key was also generated and stored
**Note**: Prior to Docker Engine 1.11, the snapshot key was also generated and stored
locally client-side. [Use the Notary CLI to manage your snapshot key locally
again](/notary/advanced_usage.md#rotate-keys) for
repositories created with newer versions of Docker.

View File

@ -81,7 +81,7 @@ $ docker service create \
nginx
```
>**Note:** You have to create the network before you can attach a service to it.
>**Note**: You have to create the network before you can attach a service to it.
The containers for the tasks in the service can connect to one another on the
overlay network. The swarm extends the network to all the nodes with `Running`
@ -220,7 +220,7 @@ the busybox container:
Address 1: 10.0.9.2 ip-10-0-9-2.us-west-2.compute.internal
```
>**Note:** the examples here use `nslookup`, but you can use `dig` or any
>**Note**: the examples here use `nslookup`, but you can use `dig` or any
available DNS query tool.
5. From inside the busybox container, query the DNS using a special query

View File

@ -20,7 +20,7 @@ To run through this tutorial, you will need:
[Swarm mode key concepts](/engine/swarm/key-concepts.md)
and [How services work](/engine/swarm/how-swarm-mode-works/services.md).
> **Note:** If you're trying things out on a local development environment,
> **Note**: If you're trying things out on a local development environment,
> you can put your engine into swarm mode with `docker swarm init`.
>
> If you've already got a multi-node swarm running, keep in mind that all

View File

@ -23,7 +23,7 @@ machines.
docker swarm init --advertise-addr <MANAGER-IP>
```
>**Note:** If you are using Docker for Mac or Docker for Windows to test
>**Note**: If you are using Docker for Mac or Docker for Windows to test
single-node swarm, simply run `docker swarm init` with no arguments. There is no
need to specify `--advertise-addr` in this case. To learn more, see the topic
on how to [Use Docker for Mac or Docker for

View File

@ -41,7 +41,7 @@ provider. This tutorial uses the following machine names:
* worker1
* worker2
>**Note:** You can follow many of the tutorial steps to test single-node swarm
>**Note**: You can follow many of the tutorial steps to test single-node swarm
as well, in which case you need only one host. Multi-node commands will not
work, but you can initialize a swarm, create services, and scale them.

View File

@ -22,7 +22,7 @@ When Docker restarts, you must
_key encryption key_ generated by Docker when the swarm was locked. You can
rotate this key encryption key at any time.
> **Note:** You don't need to unlock the swarm when a new node joins the swarm,
> **Note**: You don't need to unlock the swarm when a new node joins the swarm,
> because the key is propagated to it over mutual TLS.
## Initialize a swarm with autolocking enabled
@ -151,6 +151,6 @@ Please remember to store this key in a password manager, since without it you
will not be able to restart the manager.
```
> **Warning:** When you rotate the unlock key, keep a record of the old key
> **Warning**: When you rotate the unlock key, keep a record of the old key
> around for a few minutes, so that if a manager goes down before it gets the new
> key, it may still be locked with the old one.

View File

@ -54,7 +54,7 @@ $ docker run -d -P --name web -v /webapp training/webapp python app.py
This will create a new volume inside a container at `/webapp`.
> **Note:**
> **Note**:
> You can also use the `VOLUME` instruction in a `Dockerfile` to add one or
> more new volumes to any container created from that image.
@ -236,7 +236,7 @@ This will drop you into a bash shell in a new container, you will have your bash
history from the host and when you exit the container, the host will have the
history of the commands typed while in the container.
> **Note:**
> **Note**:
> Many tools used to edit files including `vi` and `sed --in-place` may result
> in an inode change. Since Docker v1.1.0, this will produce an error such as
> "*sed: cannot rename ./sedKdJ9Dy: Device or resource busy*". In the case where
@ -293,7 +293,7 @@ be deleted. To delete the volume from disk, you must explicitly call
`docker rm -v` against the last container with a reference to the volume. This
allows you to upgrade, or effectively migrate data volumes between containers.
> **Note:** Docker will not warn you when removing a container *without*
> **Note**: Docker will not warn you when removing a container *without*
> providing the `-v` option to delete its volumes. If you remove containers
> without using the `-v` option, you may end up with "dangling" volumes;
> volumes that are no longer referenced by a container.

View File

@ -51,7 +51,7 @@ underlying API and CLI.
The daemon creates and manages Docker _objects_, such as images, containers,
networks, and data volumes.
> **Note:** Docker is licensed under the open source Apache 2.0 license.
> **Note**: Docker is licensed under the open source Apache 2.0 license.
## What can I use Docker for?
@ -174,7 +174,7 @@ images of your own as the basis for a new image, for example if you have a base
Apache image you could use this as the base of all your web application images. The
base image is defined using the `FROM` keyword in the dockerfile.
> **Note:** [Docker Hub](https://hub.docker.com) is a public registry and stores
> **Note**: [Docker Hub](https://hub.docker.com) is a public registry and stores
images.
The docker image is built from the base image using a simple, descriptive

View File

@ -515,7 +515,7 @@ If a service can run without privileges, use `USER` to change to a non-root
user. Start by creating the user and group in the `Dockerfile` with something
like `RUN groupadd -r postgres && useradd -r -g postgres postgres`.
> **Note:** Users and groups in an image get a non-deterministic
> **Note**: Users and groups in an image get a non-deterministic
> UID/GID in that the “next” UID/GID gets assigned regardless of image
> rebuilds. So, if its critical, you should assign an explicit UID/GID.

View File

@ -33,7 +33,7 @@ container that ran a Python Flask application:
$ docker run -d -P training/webapp python app.py
> **Note:**
> **Note**:
> Containers have an internal network and an IP address
> (as we saw when we used the `docker inspect` command to show the container's
> IP address in [Run a simple application](/engine/getstarted/step_three.md) section).
@ -95,7 +95,7 @@ configurations. For example, if you've bound the container port to the
127.0.0.1:49155
> **Note:**
> **Note**:
> The `-p` flag can be used multiple times to configure multiple ports.
## Connect with the linking system
@ -143,7 +143,7 @@ name the container `web`. You can see the container's name using the
You can also use `docker inspect` to return the container's name.
> **Note:**
> **Note**:
> Container names have to be unique. That means you can only call
> one container `web`. If you want to re-use a container name you must delete
> the old container (with `docker rm`) before you can create a new
@ -343,7 +343,7 @@ that host now via any of these entries:
56 bytes from 172.17.0.5: icmp_seq=1 ttl=64 time=0.250 ms
56 bytes from 172.17.0.5: icmp_seq=2 ttl=64 time=0.256 ms
> **Note:**
> **Note**:
> In the example, you'll note you had to install `ping` because it was not included
> in the container initially.
@ -351,7 +351,7 @@ Here, you used the `ping` command to ping the `db` container using its host entr
which resolves to `172.17.0.5`. You can use this host entry to configure an application
to make use of your `db` container.
> **Note:**
> **Note**:
> You can link multiple recipient containers to a single source. For
> example, you could have multiple (differently named) web containers attached to your
>`db` container.

View File

@ -122,7 +122,7 @@ The network can then be deleted with:
docker network rm <network_name or id>
```
- **Note:** In Macvlan you are not able to ping or communicate with the default namespace IP address. For example, if you create a container and try to ping the Docker host's `eth0` it will **not** work. That traffic is explicitly filtered by the kernel modules themselves to offer additional provider isolation and security.
- **Note**: In Macvlan you are not able to ping or communicate with the default namespace IP address. For example, if you create a container and try to ping the Docker host's `eth0` it will **not** work. That traffic is explicitly filtered by the kernel modules themselves to offer additional provider isolation and security.
For more on Docker networking commands see [Working with Docker network commands](/engine/userguide/networking/work-with-networks/)

View File

@ -67,7 +67,7 @@ illustrate how they are integrated. You'll use Machine to create both the
key-value store server and the host cluster. This example creates a swarm
cluster.
>**Note:** Docker Engine running in swarm mode is not compatible with networking
>**Note**: Docker Engine running in swarm mode is not compatible with networking
with an external key-value store.
### Prerequisites

View File

@ -466,7 +466,7 @@ version of the Engine, you must install and configure your chosen key-value
store service. The Docker hosts that you intend to network and the service must
be able to communicate.
>**Note:** Docker Engine running in swarm mode is not compatible with networking
>**Note**: Docker Engine running in swarm mode is not compatible with networking
with an external key-value store.
![Key-value store](images/key_value.png)

View File

@ -492,7 +492,7 @@ The following example briefly describes how to use `--link`.
`container5` is created, `container4` will be able to resolve the name `c5` to
`container5`'s IP address.
>**Note:** Any link between containers created with *legacy link* is static in
>**Note**: Any link between containers created with *legacy link* is static in
nature and hard-binds the container with the alias. It does not tolerate
linked container restarts. The new *link* functionality in user defined
networks supports dynamic links between containers, and tolerates restarts and

View File

@ -17,7 +17,7 @@ copy-on-write, and snapshotting.
This article refers to Docker's Btrfs storage driver as `btrfs` and the overall
Btrfs Filesystem as Btrfs.
> **Note:** The [Commercially Supported Docker Engine (CS-Engine)](https://www.docker.com/compatibility-maintenance) does not currently support the `btrfs` storage driver.
> **Note**: The [Commercially Supported Docker Engine (CS-Engine)](https://www.docker.com/compatibility-maintenance) does not currently support the `btrfs` storage driver.
## The future of Btrfs
@ -194,7 +194,7 @@ multiple devices to the `mkfs.btrfs` command creates a pool across all of those
Be sure to substitute `/dev/xvdb` with the appropriate device(s) on your
system.
> **Warning:** Take note of the warning about Btrfs being experimental. As
> **Warning**: Take note of the warning about Btrfs being experimental. As
noted earlier, Btrfs is not currently recommended for production deployments
unless you already have extensive experience.

View File

@ -204,7 +204,7 @@ mode uses block devices to create the thin pool. The following procedure shows
you how to configure a Docker host to use the `devicemapper` storage driver in
a `direct-lvm` configuration.
> **Caution:** If you have already run the Docker daemon on your Docker host
> **Caution**: If you have already run the Docker daemon on your Docker host
> and have images you want to keep, `push` them to Docker Hub or your private
> Docker Trusted Registry before attempting this procedure.

View File

@ -305,7 +305,7 @@ command.
Removing intermediate container d14acd6fad4e
Successfully built 94e6b7d2c720
> **Note:** The period (.) at the end of the above command is important. It
> **Note**: The period (.) at the end of the above command is important. It
> tells the `docker build` command to use the current working directory as
> its build context.
@ -335,7 +335,7 @@ command.
The 4 image layers below it are the exact same image layers
that make up the `ubuntu:15.04` image.
> **Note:** Under the content addressable storage model introduced with Docker
> **Note**: Under the content addressable storage model introduced with Docker
> 1.10, image history data is no longer stored in a config file with each image
> layer. It is now stored as a string of text in a single config file that
> relates to the overall image. This can result in some image layers showing as

View File

@ -313,7 +313,7 @@ However, ext4 is currently recommended for use in production environments.
The following procedure shows you how to configure your Docker host to use
OverlayFS. The procedure assumes that the Docker daemon is in a stopped state.
> **Caution:** If you have already run the Docker daemon on your Docker host
> **Caution**: If you have already run the Docker daemon on your Docker host
> and have images you want to keep, `push` them to Docker Hub or your private
> Docker Trusted Registry before attempting this procedure.

View File

@ -18,7 +18,7 @@ The ZFS on Linux (ZoL) port is healthy and maturing. However, at this point in
time it is not recommended to use the `zfs` Docker storage driver for
production use unless you have substantial experience with ZFS on Linux.
> **Note:** There is also a FUSE implementation of ZFS on the Linux platform.
> **Note**: There is also a FUSE implementation of ZFS on the Linux platform.
> This should work with Docker but is not recommended. The native ZFS driver
> (ZoL) is more tested, more performant, and is more widely used. The remainder
> of this document will relate to the native ZoL port.

View File

@ -23,7 +23,7 @@ you submit good information that doesn't conform to the guide than no
information at all. Docker's tech writers are always happy to help you with the
prose, and we promise not to judge or use a red pen!
> **Note:**
> **Note**:
> The documentation is written with paragraphs wrapped at 80 column lines to
> make it easier for terminal use. You can probably set up your favorite text
> editor to do this automatically for you.
@ -169,7 +169,7 @@ Use notes sparingly and only to bring things to the reader's attention that are
critical or otherwise deserving of being called out from the body text. Please
format all notes as follows:
> **Note:**
> **Note**:
> One line of note text
> another line of note text

View File

@ -105,7 +105,7 @@ The following two examples demonstrate how to utilize this using the existing Do
### Authenticate using registry tokens
> **Note:** This example requires Docker Engine 1.10 with auth token support.
> **Note**: This example requires Docker Engine 1.10 with auth token support.
> For older Engine versions, refer to [authenticate using username and
> password](swarm-api.md#authenticate-using-username-and-password)
@ -144,7 +144,7 @@ Be aware that tokens are short-lived and will expire quickly.
### Authenticate using username and password
> **Note:** this authentication method stores your credentials unencrypted
> **Note**: this authentication method stores your credentials unencrypted
> on the filesystem. Refer to [Authenticate using registry tokens](swarm-api.md#authenticate-using-registry-tokens)
> for a more secure approach.

68
test.md
View File

@ -17,6 +17,11 @@ culpa qui officia deserunt mollit anim id est laborum.
## Heading 2
> **Note**: This is the highest heading included in the right-nav.
> To include more heading levels, set `toc_min: 1` in the page-s front-matter.
> You can go all the way to 6, but if `toc_min` is geater than `toc_max` then
> no headings will show.
Text with various styles, basic markdown formatting. You should **not** see a single line comment below this line.
<!-- This is a comment. You should not see it rendered in the page. -->
@ -43,6 +48,10 @@ Some Lorem ipsum text with formatting and styling.
### Heading 3
> **Note**: This is the lowest heading included in the right-nav, by default.
> To include more heading levels, set `toc_max: 4` in the page's front-matter.
> You can go all the way to 6.
A selection of lists, ordered and unordered, with indented sub elements.
> **Note**: This is some note text.
@ -134,8 +143,6 @@ tempor incididunt ut labore et dolore magna aliqua.
#### Heading 4
> **Note**: This is the lowest heading included in the right-nav.
Some tables in markdown and html.
| Permission level | Access |
@ -145,23 +152,28 @@ Some tables in markdown and html.
| Read/Write | Pull, push |
| Admin | All of the above, plus update description, create and delete |
If you need block-level HTML within your table cells, such as multiple
paragraphs, lists, sub-tables, etc, then you need to make a HTML table.
This is also the case if you need to use rowspans or colspans. Try to avoid
setting styles directly on your tables! If you set the width on a `<td>`, you
only need to do it on the first one. If you have a `<th>`, set it there.
<table style="width:100%">
<table>
<tr>
<th style="font-size: x-large; font-family: arial">Left channel</th>
<th style="font-size: x-large; font-family: arial">Right channel</th>
<th "width="50%">Left channel</th>
<th>Right channel</th>
</tr>
<tr valign="top">
<td width="50%">This is some test text. <br><br>This is more text on a new line. <br><br>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
<tr>
<td>This is some test text. <br><br>This is more text on a new line. <br><br>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
</td>
<td width="50%">This is some more text about the right hand side. There is a <a href="https://github.com/docker/docker/tree/master/experimental" target="_blank">link here to the Docker Experimental Features README</a> on GitHub.<br><br>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</td>
<td>This is some more text about the right hand side. There is a <a href="https://github.com/docker/docker/tree/master/experimental" target="_blank" class="_">link here to the Docker Experimental Features README</a> on GitHub.<br><br>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</td>
</tr>
<tr valign="top">
<td width="50%">
<tr>
<td>
<a class="button outline-btn" href="/">Go to the docs!</a><br><br>
<a href="/"><font color="#BDBDBD" size="-1">It is dark here. You are likely to be eaten by a grue.</font></a>
</td>
<td width="50%">
<td>
<a class="button outline-btn" href="/">Go to the docs!</a><br><br>
<a href="/"><font color="#BDBDBD" size="-1">It is dark here. You are likely to be eaten by a grue.</font></a>
</td>
@ -170,13 +182,16 @@ Some tables in markdown and html.
##### Heading 5
This heading is not included in the right-nav.
This heading is not included in the right-nav. To include it set `toc_max: 5` in
the page's front-matter.
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
###### Heading 6?!
This heading is not included in the right-nav.
This heading is not included in the right-nav. To include it set `toc_max: 6` in
the page's front-matter.
Probably not the most useful thing, but nice to know it exists.
## Some code block samples
@ -354,3 +369,30 @@ authorizedkeys:
volumes:
/root:/user:rw
```
## Admonitions
> **Note**: This is a note.
> **Info**: This is an info.
> **Tip**: This is a tip.
> **Warning**: This is a warning.
> **Caution**: This is a caution.
> **Note**: One line of note text
> another line of note text
> **Note**: This is a note with a list and a table in it.
>
> - List item 1
> - List item 2
>
> |Table column 1 | Table column 2 |
> |---------------|----------------|
> | Row 1 column 1 | Row 2 column 2 |
> | Row 2 column 1 | Row 2 column 2 |
>
> And another sentence to top it all off.

View File

@ -31,7 +31,7 @@ Docker Machine command, `docker-machine`, to create and
attach to a small Linux VM on your machine. This VM hosts
Docker Engine for you on your Mac.
>**Tip:** One of the advantages of the newer
>**Tip**: One of the advantages of the newer
[Docker for Mac](/docker-for-mac/index.md) solution is that
it uses native virtualization and does not require
VirtualBox to run Docker.

View File

@ -32,7 +32,7 @@ command, `docker-machine`, to create and attach to a
small Linux VM on your machine. This VM hosts Docker Engine
for you on your Windows system.
>**Tip:** One of the advantages of the newer
>**Tip**: One of the advantages of the newer
[Docker for
Windows](/docker-for-windows/index.md) solution is that
it uses native virtualization and does not require
@ -225,7 +225,7 @@ To uninstall Toolbox on Windows, do the following:
3. Uninstall Docker Toolbox using Window's standard process for uninstalling programs through the control panel.
>**Note:** This process does not remove the `docker-install.exe` file. You must delete that file yourself.
>**Note**: This process does not remove the `docker-install.exe` file. You must delete that file yourself.
5. Optionally, remove the
`C:\Users\<your-user>\.docker` directory.