Use consistent formatting for notes

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
PKinvest · Feb 8, 2019 · 03d5b33 · 03d5b33
1 parent 4f5f6a4
commit 03d5b33
Show file tree

Hide file tree

Showing 42 changed files with 101 additions and 92 deletions.
diff --git a/_includes/ee-linux-install-reuse.md b/_includes/ee-linux-install-reuse.md
@@ -137,7 +137,7 @@ You only need to set up the repository once, after which you can install Docker
 
 {% elsif section == "install-using-yum-repo" %}
 
-> ***NOTE:*** If you need to run Docker EE 2.0, please see the following instructions:
+> **Note**: If you need to run Docker EE 2.0, please see the following instructions:
 > * [18.03](https://docs.docker.com/v18.03/ee/supported-platforms/) - Older Docker EE Engine only release
 > * [17.06](https://docs.docker.com/v17.06/engine/installation/) - Docker Enterprise Edition 2.0 (Docker Engine, 
 > UCP, and DTR).

diff --git a/compose/compose-file/compose-file-v2.md b/compose/compose-file/compose-file-v2.md
@@ -990,7 +990,7 @@ as it has the highest priority. It then connects to `app_net_3`, then
       app_net_2:
       app_net_3:
 
-> **Note:** If multiple networks have the same priority, the connection order
+> **Note**: If multiple networks have the same priority, the connection order
 > is undefined.
 
 ### pid
@@ -1235,7 +1235,7 @@ volumes:
   mydata:
 ```
 
-> **Note:** When creating bind mounts, using the long syntax requires the
+> **Note**: When creating bind mounts, using the long syntax requires the
 > referenced folder to be created beforehand. Using the short syntax
 > creates the folder on the fly if it doesn't exist.
 > See the [bind mounts documentation](/engine/admin/volumes/bind-mounts.md/#differences-between--v-and---mount-behavior)
@@ -1248,7 +1248,7 @@ service.
 
     volume_driver: mydriver
 
-> **Note:** In [version 2 files](compose-versioning.md#version-2), this
+> **Note**: In [version 2 files](compose-versioning.md#version-2), this
 > option only applies to anonymous volumes (those specified in the image,
 > or specified under `volumes` without an explicit named volume or host path).
 > To configure the driver for a named volume, use the `driver` key under the
@@ -1298,7 +1298,7 @@ then read-write is used.
 Each of these is a single value, analogous to its
 [docker run](/engine/reference/run.md) counterpart.
 
-> **Note:** The following options were added in [version 2.2](compose-versioning.md#version-22):
+> **Note**: The following options were added in [version 2.2](compose-versioning.md#version-22):
 > `cpu_count`, `cpu_percent`, `cpus`.
 > The following options were added in [version 2.1](compose-versioning.md#version-21):
 > `oom_kill_disable`, `cpu_period`

diff --git a/compose/compose-file/index.md b/compose/compose-file/index.md
@@ -279,7 +279,7 @@ at build time is the value in the environment where Compose is running.
 
 #### cache_from
 
-> **Note:** This option is new in v3.2
+> **Note**: This option is new in v3.2
 
 A list of images that the engine uses for cache resolution.
 
@@ -291,7 +291,7 @@ A list of images that the engine uses for cache resolution.
 
 #### labels
 
-> **Note:** This option is new in v3.3
+> **Note**: This option is new in v3.3
 
 Add metadata to the resulting image using [Docker labels](/engine/userguide/labels-custom-metadata.md).
 You can use either an array or a dictionary.
@@ -490,7 +490,7 @@ an error.
 
 ### credential_spec
 
-> **Note:** this option was added in v3.3.
+> **Note**: this option was added in v3.3.
 
 Configure the credential spec for managed service account. This option is only
 used for services using Windows containers. The `credential_spec` must be in the
@@ -1431,7 +1431,7 @@ containers in the bare-metal machine's namespace and vice versa.
 
 Expose ports.
 
-> **Note:** Port mapping is incompatible with `network_mode: host`
+> **Note**: Port mapping is incompatible with `network_mode: host`
 
 #### Short syntax
 
@@ -1473,7 +1473,7 @@ ports:
 
 ```
 
-> **Note:** The long syntax is new in v3.2
+> **Note**: The long syntax is new in v3.2
 
 ### restart
 
@@ -1810,7 +1810,7 @@ volumes:
   mydata:
 ```
 
-> **Note:** The long syntax is new in v3.2
+> **Note**: The long syntax is new in v3.2
 
 
 #### Volumes for services, swarms, and stack files

diff --git a/compose/install.md b/compose/install.md
@@ -129,7 +129,7 @@ by step instructions are also included below.
     sudo chmod +x /usr/local/bin/docker-compose
     ```
     
-> ***Note:*** If the command `docker-compose` fails after installation, check your path.
+> **Note**: If the command `docker-compose` fails after installation, check your path.
 > You can also create a symbolic link to `/usr/bin` or any other directory in your path.
 
 For example:

diff --git a/datacenter/dtr/2.3/reference/cli/install.md b/datacenter/dtr/2.3/reference/cli/install.md
@@ -24,11 +24,13 @@ command.
 
 Example usage:
 
+```bash
 $ docker run -it --rm dtr-internal.caas.docker.io/caas/dtr:2.4.0-alpha-008434_ge02413a install \
 	--ucp-node <UCP_NODE_HOSTNAME> \
 	--ucp-insecure-tls
+```
 
-Note: Use --ucp-ca "$(cat ca.pem)" instead of --ucp-insecure-tls for a production deployment.
+> **Note**: Use `--ucp-ca "$(cat ca.pem)"` instead of `--ucp-insecure-tls` for a production deployment.
 
 ## Options
 

diff --git a/datacenter/dtr/2.4/reference/cli/install.md b/datacenter/dtr/2.4/reference/cli/install.md
@@ -24,11 +24,13 @@ command.
 
 Example usage:
 
+```bash
 $ docker run -it --rm docker/dtr:2.4.1 install \
 	--ucp-node <UCP_NODE_HOSTNAME> \
 	--ucp-insecure-tls
+```
 
-Note: Use --ucp-ca "$(cat ca.pem)" instead of --ucp-insecure-tls for a production deployment.
+> **Note**: Use `--ucp-ca "$(cat ca.pem)"` instead of `--ucp-insecure-tls` for a production deployment.
 
 ## Options
 

diff --git a/datacenter/ucp/1.1/release_notes.md b/datacenter/ucp/1.1/release_notes.md
@@ -14,10 +14,10 @@ upgrade your installation to the latest release.
 
 (18 Jan 2017)
 
-Note: UCP 1.1.6 supports Docker Engine 1.12 but does not use the built-in
-orchestration capabilities provided by the Docker Engine with swarm mode enabled.
-When installing this UCP version on a Docker Engine 1.12 host, UCP creates a
-cluster using the older Docker Swarm v1.2.
+> **Note**: UCP 1.1.6 supports Docker Engine 1.12 but does not use the built-in
+> orchestration capabilities provided by the Docker Engine with swarm mode enabled.
+> When installing this UCP version on a Docker Engine 1.12 host, UCP creates a
+> cluster using the older Docker Swarm v1.2.
 
 **Security Update**
 
@@ -41,10 +41,10 @@ the [permissions levels section](user-management/permission-levels.md) for more
 
 (8 Dec 2016)
 
-Note: UCP 1.1.5 supports Docker Engine 1.12 but does not use the built-in
-orchestration capabilities provided by the Docker Engine with swarm mode enabled.
-When installing this UCP version on a Docker Engine 1.12 host, UCP creates a
-cluster using the older Docker Swarm v1.2.
+> **Note**: UCP 1.1.5 supports Docker Engine 1.12 but does not use the built-in
+> orchestration capabilities provided by the Docker Engine with swarm mode enabled.
+> When installing this UCP version on a Docker Engine 1.12 host, UCP creates a
+> cluster using the older Docker Swarm v1.2.
 
 **Bug fixes**
 
@@ -61,10 +61,10 @@ the authentication process.
 
 (29 Sept 2016)
 
-Note: UCP 1.1.4 supports Docker Engine 1.12 but does not use the built-in
-orchestration capabilities provided by the Docker Engine with swarm mode enabled.
-When installing this UCP version on a Docker Engine 1.12 host, UCP creates a
-cluster using Docker Swarm v1.2.5.
+> **Note**: UCP 1.1.4 supports Docker Engine 1.12 but does not use the built-in
+> orchestration capabilities provided by the Docker Engine with swarm mode enabled.
+> When installing this UCP version on a Docker Engine 1.12 host, UCP creates a
+> cluster using Docker Swarm v1.2.5.
 
 **Bug fixes**
 
@@ -76,10 +76,10 @@ organization accounts
 
 ## Version 1.1.3
 
-Note: UCP 1.1.3 supports Docker Engine 1.12 but does not use the built-in
-orchestration capabilities provided by the Docker Engine with swarm mode enabled.
-When installing this UCP version on a Docker Engine 1.12 host, UCP creates a
-cluster using Docker Swarm v1.2.5.
+> **Note**: UCP 1.1.3 supports Docker Engine 1.12 but does not use the built-in
+> orchestration capabilities provided by the Docker Engine with swarm mode enabled.
+> When installing this UCP version on a Docker Engine 1.12 host, UCP creates a
+> cluster using Docker Swarm v1.2.5.
 
 **Security Update**
 
@@ -125,9 +125,9 @@ enabled, and is not compatible with swarm-mode based APIs, e.g. `docker service`
 
 ## Version 1.1.2
 
-Note: UCP 1.1.2 supports Docker Engine 1.12 but doesn't use the new clustering
-capabilities provided by the Docker swarm mode. When installing this UCP version
-on a Docker Engine 1.12, UCP creates a "classic" Docker Swarm 1.2.3 cluster.
+> **Note**: UCP 1.1.2 supports Docker Engine 1.12 but doesn't use the new clustering
+> capabilities provided by the Docker swarm mode. When installing this UCP version
+> on a Docker Engine 1.12, UCP creates a "classic" Docker Swarm 1.2.3 cluster.
 
 **Features**
 

diff --git a/datacenter/ucp/2.2/guides/user/services/use-domain-names-to-access-services.md b/datacenter/ucp/2.2/guides/user/services/use-domain-names-to-access-services.md
@@ -194,7 +194,8 @@ apply two labels to your service:
 com.docker.ucp.mesh.http.1=external_route=http://example.org,redirect=https://example.org
 com.docker.ucp.mesh.http.2=external_route=sni://example.org
 ```
-Note: It is not possible to redirect HTTPS to HTTP. 
+
+> **Note**: It is not possible to redirect HTTPS to HTTP.
 
 ### X-Forwarded-For header
 

diff --git a/datacenter/ucp/3.0/guides/admin/install/upgrade.md b/datacenter/ucp/3.0/guides/admin/install/upgrade.md
@@ -22,7 +22,7 @@ impact to your users.
 Don't make changes to UCP configurations while you're upgrading.
 This can lead to misconfigurations that are difficult to troubleshoot.
 
-> Note: If you are upgrading a cluster to UCP 3.0.2 or higher on Microsoft 
+> **Note**: If you are upgrading a cluster to UCP 3.0.2 or higher on Microsoft
 > Azure then please ensure all of the Azure [prerequisities](install-on-azure.md/#azure-prerequisites) 
 > are met.  
 

diff --git a/datacenter/ucp/3.0/guides/user/services/use-domain-names-to-access-services.md b/datacenter/ucp/3.0/guides/user/services/use-domain-names-to-access-services.md
@@ -187,7 +187,8 @@ apply two labels to your service:
 com.docker.ucp.mesh.http.1=external_route=http://example.org,redirect=https://example.org
 com.docker.ucp.mesh.http.2=external_route=sni://example.org
 ```
-Note: It is not possible to redirect HTTPS to HTTP. 
+
+> **Note**: It is not possible to redirect HTTPS to HTTP.
 
 ### X-Forwarded-For header
 

diff --git a/docker-for-mac/index.md b/docker-for-mac/index.md
@@ -412,9 +412,9 @@ $ security add-trusted-cert -d -r trustRoot -k ~/Library/Keychains/login.keychai
 See also, [Directory structures for
 certificates](#directory-structures-for-certificates).
 
-> **Note:** You need to restart Docker Desktop for Mac after making any changes to the
-keychain or to the `~/.docker/certs.d` directory in order for the changes to
-take effect.
+> **Note**: You need to restart Docker Desktop for Mac after making any changes to the
+> keychain or to the `~/.docker/certs.d` directory in order for the changes to
+> take effect.
 
 For a complete explanation of how to do this, see the blog post [Adding
 Self-signed Registry Certs to Docker & Docker Desktop for

diff --git a/docker-hub/builds/index.md b/docker-hub/builds/index.md
@@ -129,9 +129,9 @@ For each source:
 
 * Specify the **Dockerfile location** as a path relative to the root of the source code repository. (If the Dockerfile is at the repository root, leave this path set to `/`.)
 
-> **Note:** When Docker Hub pulls a branch from a source code repository, it performs
-a shallow clone (only the tip of the specified branch).  Refer to [Advanced options for Autobuild and Autotest](advanced.md)
-for more information.
+> **Note**: When Docker Hub pulls a branch from a source code repository, it performs
+> a shallow clone (only the tip of the specified branch).  Refer to [Advanced options for Autobuild and Autotest](advanced.md)
+> for more information.
 
 ### Environment variables for builds
 

diff --git a/docker-hub/orgs.md b/docker-hub/orgs.md
@@ -13,7 +13,7 @@ Docker Hub Organizations let you create teams so you can give your team access t
 - **Organizations** are a collection of teams and repositories that can be managed together.
 - **Teams** are groups of Docker Hub users that belong to your organization.
 
-**Note:** in Docker Hub, users cannot be associated directly to an organization. They belong only to teams within an organization.
+> **Note**: in Docker Hub, users cannot be associated directly to an organization. They belong only to teams within an organization.
 
 ### Creating an organization
 
@@ -48,7 +48,7 @@ To create a team:
 2. Click on **Add User**
 3. Provide the user's Docker ID username _or_ email to add them to the team ![Add User to Team](images/orgs-team-add-user.png)
 
-**Note:** you are not automatically added to teams created by your organization.
+> **Note**: you are not automatically added to teams created by your organization.
 
 ### Removing team members
 

diff --git a/docker-hub/publish/certify-images.md b/docker-hub/publish/certify-images.md
@@ -466,11 +466,12 @@ root:[~/] #
 root:[~/] # ./inspectDockerImage --json gforghetti/apache:latest | jq
 ```
 
-Note: The output was piped to the **jq** command to display it "nicely".
+
+> **Note**: The output was piped to the `jq` command to display it "nicely".
 
 #### Output:
 
-```
+```json
 {
   "Date": "Mon May 21 13:23:37 2018",
   "SystemOperatingSystem": "Operating System: Ubuntu 16.04.4 LTS",
@@ -580,7 +581,6 @@ Note: The output was piped to the **jq** command to display it "nicely".
     }
   ]
 }
-root:[~/] #
 ```
 
 <a name="linux-with-html">

diff --git a/docker-hub/publish/certify-plugins-logging.md b/docker-hub/publish/certify-plugins-logging.md
@@ -364,12 +364,11 @@ gforghetti:~/$
 gforghetti:~:$ ./inspectDockerLoggingPlugin --json gforghetti/docker-log-driver-test:latest | jq
 ```
 
-> Note: The output was piped to the **jq** command to display it "nicely".
+> **Note**: The output was piped to the `jq` command to display it "nicely".
 
 #### Output:
 
-
-```
+```json
  {
   "Date": "Mon May 21 14:38:28 2018",
   "SystemOperatingSystem": "Operating System: Ubuntu 16.04.4 LTS",

diff --git a/ee/dtr/admin/configure/deploy-caches/simple-kube.md b/ee/dtr/admin/configure/deploy-caches/simple-kube.md
@@ -82,7 +82,7 @@ stored in the primary DTR. You can
 [customize the storage parameters](/registry/configuration/#storage),
 if you want the cached images to be backended by persistent storage.
 
-> Note: Kubernetes Peristent Volumes or Persistent Volume Claims would have to be 
+> **Note**: Kubernetes Peristent Volumes or Persistent Volume Claims would have to be
 > used to provide persistent backend storage capabilities for the cache.
 
 ```

diff --git a/ee/dtr/admin/configure/use-a-web-proxy.md b/ee/dtr/admin/configure/use-a-web-proxy.md
@@ -38,7 +38,8 @@ docker run -it --rm \
   --https-proxy username:password@<doman>:<port> \
   --ucp-insecure-tls
 ```
-NOTE: DTR will hide the password portion of the URL, when it is displayed in the DTR UI.
+
+> **Note**: DTR will hide the password portion of the URL, when it is displayed in the DTR UI.
 
 ## Where to go next
 

diff --git a/ee/ucp/admin/configure/external-auth/index.md b/ee/ucp/admin/configure/external-auth/index.md
@@ -141,7 +141,7 @@ Click **Yes** to enable integrating UCP users and teams with LDAP servers.
 | No simple pagination  | If your LDAP server doesn't support pagination.                                                                                                                           |
 | Just-In-Time User Provisioning | Whether to create user accounts only when users log in for the first time. The default value of `true` is recommended. If you upgraded from UCP 2.0.x, the default is `false`. |
 
-> **Note:** LDAP connections using certificates created with TLS v1.2 do not currently advertise support for sha512WithRSAEncryption in the TLS handshake which leads to issues establishing connections with some clients. Support for advertising sha512WithRSAEncryption will be added in UCP 3.1.0.  
+> **Note**: LDAP connections using certificates created with TLS v1.2 do not currently advertise support for sha512WithRSAEncryption in the TLS handshake which leads to issues establishing connections with some clients. Support for advertising sha512WithRSAEncryption will be added in UCP 3.1.0.
 
 ![](../../../images/ldap-integration-1.png){: .with-border}
 

diff --git a/ee/ucp/admin/install/plan-installation.md b/ee/ucp/admin/install/plan-installation.md
@@ -44,7 +44,7 @@ this.
 
 Swarm uses a default address pool of `10.0.0.0/16` for its overlay networks. If this conflicts with your current network implementation, please use a custom IP address pool. To specify a custom IP address pool, use the `--default-address-pool` command line option during [Swarm initialization](../../../../engine/swarm/swarm-mode.md). 
 
-**NOTE:** Currently, the UCP installation process does not support this flag. To deploy with a custom IP pool, Swarm must first be installed using this flag and UCP must be installed on top of it.
+> **Note**: Currently, the UCP installation process does not support this flag. To deploy with a custom IP pool, Swarm must first be installed using this flag and UCP must be installed on top of it.
 
 Kubernetes uses a default cluster IP pool for pods that is `192.168.0.0/16`. If it conflicts with your current networks, please use a custom IP pool by specifying `--pod-cidr` during UCP installation.
 

diff --git a/ee/ucp/admin/install/upgrade.md b/ee/ucp/admin/install/upgrade.md
@@ -29,7 +29,7 @@ Learn about [UCP system requirements](system-requirements.md).
 Ensure that your cluster nodes meet the minimum requirements for port openings.
 [Ports used](system-requirements.md/#ports-used) are documented in the UCP system requirements. 
 
-> Note: If you are upgrading a cluster to UCP 3.0.2 or higher on Microsoft 
+> **Note**: If you are upgrading a cluster to UCP 3.0.2 or higher on Microsoft
 > Azure then please ensure all of the Azure [prerequisites](install-on-azure.md/#azure-prerequisites) 
 > are met.  
 

diff --git a/ee/ucp/authorization/ee-standard.md b/ee/ucp/authorization/ee-standard.md
@@ -53,7 +53,7 @@ built-in collection, `/Shared`.
 
 Other collections are also being created to enable shared `db` applications.
 
-> **Note:** For increased security with node-based isolation, use Docker
+> **Note**: For increased security with node-based isolation, use Docker
 > Enterprise Advanced.
 
 - `/Shared/mobile` hosts all Mobile applications and resources.
@@ -107,7 +107,7 @@ collection boundaries. By assigning multiple grants per team, the Mobile and
 Payments applications teams can connect to dedicated Database resources through
 a secure and controlled interface, leveraging Database networks and secrets.
 
-> **Note:** In Docker Enterprise Standard, all resources are deployed across the
+> **Note**: In Docker Enterprise Standard, all resources are deployed across the
 > same  group of UCP worker nodes. Node segmentation is provided in Docker
 > Enterprise Advanced and discussed in the [next tutorial](ee-advanced.md).
 

diff --git a/ee/ucp/interlock/usage/sessions.md b/ee/ucp/interlock/usage/sessions.md
@@ -125,7 +125,7 @@ $> curl -vs -H "Host: demo.local" http://127.0.0.1/ping
 You can use `docker service scale demo=10` to add some more replicas.  Once scaled, you will notice that requests are pinned
 to a specific backend.
 
-Note: due to the way the IP hashing works for extensions, you will notice a new upstream address when scaling replicas.  This is
-expected as internally the proxy uses the new set of replicas to decide on a backend on which to pin.  Once the upstreams are
-determined a new "sticky" backend will be chosen and that will be the dedicated upstream.
+> **Note**: due to the way the IP hashing works for extensions, you will notice a new upstream address when scaling replicas.  This is
+> expected as internally the proxy uses the new set of replicas to decide on a backend on which to pin.  Once the upstreams are
+> determined a new "sticky" backend will be chosen and that will be the dedicated upstream.