1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00

Fixes found by docs validation tool

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
This commit is contained in:
Sven Dowideit 2015-11-23 11:15:39 +10:00
parent 49f982b7ba
commit 043f447e2e
27 changed files with 54 additions and 29 deletions

View file

@ -86,7 +86,7 @@ own.
6. Check your writing for style and mechanical errors. 6. Check your writing for style and mechanical errors.
Use our [documentation style Use our [documentation style
guide](doc-style.md) to check style. There are guide](/opensource/doc-style.md) to check style. There are
several [good grammar and spelling online several [good grammar and spelling online
checkers](http://www.hemingwayapp.com/) that can check your writing checkers](http://www.hemingwayapp.com/) that can check your writing
mechanics. mechanics.
@ -106,7 +106,7 @@ links that are referenced in the documentation&mdash;there should be none.
## Style guide ## Style guide
If you have questions about how to write for Docker's documentation, please see If you have questions about how to write for Docker's documentation, please see
the [style guide](doc-style.md). The style guide provides the [style guide](/opensource/doc-style.md). The style guide provides
guidance about grammar, syntax, formatting, styling, language, or tone. If guidance about grammar, syntax, formatting, styling, language, or tone. If
something isn't clear in the guide, please submit an issue to let us know or something isn't clear in the guide, please submit an issue to let us know or
submit a pull request to help us improve it. submit a pull request to help us improve it.

View file

@ -1,3 +1,9 @@
<!--[metadata]>
+++
draft = true
+++
<![end-metadata]-->
This is an initial attempt to make it easier to test the examples in the https.md This is an initial attempt to make it easier to test the examples in the https.md

View file

@ -113,4 +113,4 @@ You can find more details about Docker on openSUSE or SUSE Linux Enterprise in t
[Docker quick start guide](https://www.suse.com/documentation/sles-12/dockerquick/data/dockerquick.html) [Docker quick start guide](https://www.suse.com/documentation/sles-12/dockerquick/data/dockerquick.html)
on the SUSE website. The document targets SUSE Linux Enterprise, but its contents apply also to openSUSE. on the SUSE website. The document targets SUSE Linux Enterprise, but its contents apply also to openSUSE.
Continue to the [User Guide](../userguide/). Continue to the [User Guide](../userguide/index.md).

View file

@ -24,7 +24,7 @@ machines on Azure:
## What next? ## What next?
Continue with the [User Guide](../userguide/). Continue with the [User Guide](../userguide/index.md).
[0]: http://azure.microsoft.com/ [0]: http://azure.microsoft.com/
[1]: http://azure.microsoft.com/en-us/documentation/articles/virtual-machines-docker-vm-extension/ [1]: http://azure.microsoft.com/en-us/documentation/articles/virtual-machines-docker-vm-extension/

View file

@ -37,7 +37,7 @@ runtime:
## Check kernel dependencies ## Check kernel dependencies
Docker in daemon mode has specific kernel requirements. For details, Docker in daemon mode has specific kernel requirements. For details,
check your distribution in [*Installation*](../installation#installation-list). check your distribution in [*Installation*](index.md#on-linux).
A 3.10 Linux kernel is the minimum requirement for Docker. A 3.10 Linux kernel is the minimum requirement for Docker.
Kernels older than 3.10 lack some of the features required to run Docker Kernels older than 3.10 lack some of the features required to run Docker
@ -211,4 +211,4 @@ Then follow the regular installation steps.
# run a container and open an interactive shell in the container # run a container and open an interactive shell in the container
$ sudo ./docker run -i -t ubuntu /bin/bash $ sudo ./docker run -i -t ubuntu /bin/bash
Continue with the [User Guide](../userguide). Continue with the [User Guide](../userguide/index.md).

View file

@ -170,4 +170,4 @@ You must delete the user created configuration files manually.
## What next? ## What next?
Continue with the [User Guide](../userguide/). Continue with the [User Guide](../userguide/index.md).

View file

@ -42,7 +42,7 @@ Instructions for installing prior releases of Docker can be found in the followi
[Docker v1.7](http://docs.docker.com/v1.7/), [Docker v1.6](http://docs.docker.com/v1.6/), [Docker v1.5](http://docs.docker.com/v1.5/), and [Docker v1.4](http://docs.docker.com/v1.4/). [Docker v1.7](http://docs.docker.com/v1.7/), [Docker v1.6](http://docs.docker.com/v1.6/), [Docker v1.5](http://docs.docker.com/v1.5/), and [Docker v1.4](http://docs.docker.com/v1.4/).
## Where to go After Installing ## Where to go After Installing
* [About Docker](../misc) * [About Docker](../misc/index.md)
* [Support](https://www.docker.com/support/) * [Support](https://www.docker.com/support/)
* [Training](https://training.docker.com//) * [Training](https://training.docker.com//)

View file

@ -20,4 +20,4 @@ Joyent provides a `sdc-docker-setup.sh` script that makes it easy to use Docker
with Joyent. The [Docker API guide for with Joyent. The [Docker API guide for
Triton](https://apidocs.joyent.com/docker) has details on using this script. Triton](https://apidocs.joyent.com/docker) has details on using this script.
Once you are up and running with Joyent, continue with the [Docker user guide](../userguide/). Once you are up and running with Joyent, continue with the [Docker user guide](../userguide/index.md).

View file

@ -425,6 +425,6 @@ Use `docker-machine help` to list the full command line reference for Docker Mac
information about using SSH or SCP to access a VM, see [the Docker Machine information about using SSH or SCP to access a VM, see [the Docker Machine
documentation](https://docs.docker.com/machine/). documentation](https://docs.docker.com/machine/).
You can continue with the [Docker User Guide](../userguide). If you are You can continue with the [Docker User Guide](../userguide/index.md). If you are
interested in using the Kitematic GUI, see the [Kitematic user interested in using the Kitematic GUI, see the [Kitematic user
guide](https://docs.docker.com/kitematic/userguide/). guide](https://docs.docker.com/kitematic/userguide/).

View file

@ -32,5 +32,5 @@ parent = "smn_cloud"
## What next? ## What next?
Continue with the [User Guide](../userguide/). Continue with the [User Guide](../userguide/index.md).

View file

@ -362,6 +362,6 @@ delete that file yourself.
## Learn more ## Learn more
You can continue with the [Docker User Guide](../userguide). If you are You can continue with the [Docker User Guide](../userguide/index.md). If you are
interested in using the Kitematic GUI, see the [Kitematic user interested in using the Kitematic GUI, see the [Kitematic user
guide](https://docs.docker.com/kitematic/userguide/). guide](https://docs.docker.com/kitematic/userguide/).

View file

@ -285,9 +285,9 @@ BSD Jails or Solaris Zones.
## Next steps ## Next steps
### Installing Docker ### Installing Docker
Visit the [installation section](../installation/#installation). Visit the [installation section](../installation/index.md#installation).
### The Docker user guide ### The Docker user guide
[Learn Docker in depth](../userguide/). [Learn Docker in depth](../userguide/index.md).

View file

@ -269,4 +269,4 @@ You can find more answers on:
- [Ask questions on Stackoverflow](http://stackoverflow.com/search?q=docker) - [Ask questions on Stackoverflow](http://stackoverflow.com/search?q=docker)
- [Join the conversation on Twitter](http://twitter.com/docker) - [Join the conversation on Twitter](http://twitter.com/docker)
Looking for something else to read? Checkout the [User Guide](../userguide/). Looking for something else to read? Checkout the [User Guide](../userguide/index.md).

View file

@ -83,14 +83,14 @@ The [Understanding Docker section](../introduction/understanding-docker.md) will
### Installation guides ### Installation guides
The [installation section](../installation) will show you how to install Docker The [installation section](../installation/index.md) will show you how to install Docker
on a variety of platforms. on a variety of platforms.
### Docker user guide ### Docker user guide
To learn about Docker in more detail and to answer questions about usage and To learn about Docker in more detail and to answer questions about usage and
implementation, check out the [Docker User Guide](../userguide/). implementation, check out the [Docker User Guide](../userguide/index.md).
## Release notes ## Release notes

View file

@ -1,3 +1,9 @@
<!--[metadata]>
+++
draft = true
+++
<![end-metadata]-->
This directory holds the authoritative specifications of APIs defined and implemented by Docker. Currently this includes: This directory holds the authoritative specifications of APIs defined and implemented by Docker. Currently this includes:
* The remote API by which a docker node can be queried over HTTP * The remote API by which a docker node can be queried over HTTP

View file

@ -1204,7 +1204,7 @@ or a signal name in the format SIGNAME, for instance SIGKILL.
## Dockerfile examples ## Dockerfile examples
Below you can see some examples of Dockerfile syntax. If you're interested in Below you can see some examples of Dockerfile syntax. If you're interested in
something more realistic, take a look at the list of [Dockerization examples](../examples/). something more realistic, take a look at the list of [Dockerization examples](../examples/index.md).
``` ```
# Nginx # Nginx

View file

@ -31,7 +31,7 @@ each `docker` command with `sudo`. To avoid having to use `sudo` with the
`docker` and add users to it. `docker` and add users to it.
For more information about installing Docker or `sudo` configuration, refer to For more information about installing Docker or `sudo` configuration, refer to
the [installation](../../installation) instructions for your operating system. the [installation](../../installation/index.md) instructions for your operating system.
## Environment variables ## Environment variables

View file

@ -7,7 +7,8 @@ keywords = ["Docker, Docker documentation, CLI, command line"]
identifier= "smn_cli" identifier= "smn_cli"
parent = "mn_reference" parent = "mn_reference"
+++ +++
<!-- [end-metadata]--> <![end-metadata]-->
# The Docker commands # The Docker commands

View file

@ -1,3 +1,9 @@
<!-- [metadata]>
+++
draft = true
+++
<![end-metadata]-->
AppArmor security profiles for Docker AppArmor security profiles for Docker
-------------------------------------- --------------------------------------

View file

@ -10,7 +10,7 @@ parent= "smn_content_trust"
# Deploying Notary Server with Compose # Deploying Notary Server with Compose
The easiest way to deploy Notary Server is by using Docker Compose. To follow the procedure on this page, you must have already [installed Docker Compose](../../../compose/install.md). The easiest way to deploy Notary Server is by using Docker Compose. To follow the procedure on this page, you must have already [installed Docker Compose](/compose/install.md).
1. Clone the Notary repository 1. Clone the Notary repository

View file

@ -25,7 +25,7 @@ have `sudo` privileges on your local machine or in the VM.
This sandbox requires you to install two Docker tools: Docker Engine and Docker This sandbox requires you to install two Docker tools: Docker Engine and Docker
Compose. To install the Docker Engine, choose from the [list of supported Compose. To install the Docker Engine, choose from the [list of supported
platforms](../../installation). To install Docker Compose, see the platforms](../../installation/index.md). To install Docker Compose, see the
[detailed instructions here](https://docs.docker.com/compose/install/). [detailed instructions here](https://docs.docker.com/compose/install/).
Finally, you'll need to have `git` installed on your local system or VM. Finally, you'll need to have `git` installed on your local system or VM.

View file

@ -1,3 +1,9 @@
<!--[metadata]>
+++
draft = true
+++
<![end-metadata]-->
Static files dir Static files dir
================ ================

View file

@ -28,7 +28,7 @@ to preface each `docker` command with `sudo`. One way to avoid having to use
add users that will be entering `docker` commands to the 'docker' group. add users that will be entering `docker` commands to the 'docker' group.
For more information about installing Docker or `sudo` configuration, refer to For more information about installing Docker or `sudo` configuration, refer to
the [installation](../installation) instructions for your operating system. the [installation](../installation/index.md) instructions for your operating system.
## Download a pre-built image ## Download a pre-built image

View file

@ -48,6 +48,6 @@ operates on. You use Docker to push and pull images (data) to a registry.
Content trust gives you the ability to both verify the integrity and the Content trust gives you the ability to both verify the integrity and the
publisher of all the data received from a registry over any channel. publisher of all the data received from a registry over any channel.
[Content trust](../security/trust/) is currently only available for users of the [Content trust](../security/trust/index.md) is currently only available for users of the
public Docker Hub. It is currently not available for the Docker Trusted Registry public Docker Hub. It is currently not available for the Docker Trusted Registry
or for private registries. or for private registries.

View file

@ -10,7 +10,7 @@ parent = "mn_fun_docker"
# Welcome to the Docker user guide # Welcome to the Docker user guide
In the [Introduction](../misc) you got a taste of what Docker is and how it In the [Introduction](../misc/index.md) you got a taste of what Docker is and how it
works. This guide takes you through the fundamentals of using Docker and works. This guide takes you through the fundamentals of using Docker and
integrating it into your environment. You'll learn how to use Docker to: integrating it into your environment. You'll learn how to use Docker to:

View file

@ -16,7 +16,7 @@ This content was extracted from the original introduction. We may want to add it
## A Brief introduction to networking and docker ## A Brief introduction to networking and docker
When Docker starts, it creates a virtual interface named `docker0` on the host machine. It randomly chooses an address and subnet from the private range defined by [RFC 1918](http://tools.ietf.org/html/rfc1918) that are not in use on the host machine, and assigns it to `docker0`. Docker made the choice `172.17.42.1/16` when I started it a few minutes ago, for example -- a 16-bit netmask providing 65,534 addresses for the host machine and its containers. The MAC address is generated using the IP address allocated to the container to avoid ARP collisions, using a range from `02:42:ac:11:00:00` to `02:42:ac:11:ff:ff`. When Docker starts, it creates a virtual interface named `docker0` on the host machine. It randomly chooses an address and subnet from the private range defined by [RFC 1918](http://tools.ietf.org/html/rfc1918) that are not in use on the host machine, and assigns it to `docker0`. Docker made the choice `172.17.42.1/16` when I started it a few minutes ago, for example -- a 16-bit netmask providing 65,534 addresses for the host machine and its containers. The MAC address is generated using the IP address allocated to the container to avoid ARP collisions, using a range from `02:42:ac:11:00:00` to `02:42:ac:11:ff:ff`.
> **Note:** This document discusses advanced networking configuration and options for Docker. In most cases you won't need this information. If you're looking to get started with a simpler explanation of Docker networking and an introduction to the concept of container linking see the [Docker User Guide](/userguide/networking/networking/default_network/dockerlinks.md/). > **Note:** This document discusses advanced networking configuration and options for Docker. In most cases you won't need this information. If you're looking to get started with a simpler explanation of Docker networking and an introduction to the concept of container linking see the [Docker User Guide](dockerlinks.md).
But `docker0` is no ordinary interface. It is a virtual _Ethernet bridge_ that automatically forwards packets between any other network interfaces that are attached to it. This lets containers communicate both with the host machine and with each other. Every time Docker creates a container, it creates a pair of "peer" interfaces that are like opposite ends of a pipe -- a packet sent on one will be received on the other. It gives one of the peers to the container to become its `eth0` interface and keeps the other peer, with a unique name like `vethAQI2QT`, out in the namespace of the host machine. By binding every `veth*` interface to the `docker0` bridge, Docker creates a virtual subnet shared between the host machine and every Docker container. But `docker0` is no ordinary interface. It is a virtual _Ethernet bridge_ that automatically forwards packets between any other network interfaces that are attached to it. This lets containers communicate both with the host machine and with each other. Every time Docker creates a container, it creates a pair of "peer" interfaces that are like opposite ends of a pipe -- a packet sent on one will be received on the other. It gives one of the peers to the container to become its `eth0` interface and keeps the other peer, with a unique name like `vethAQI2QT`, out in the namespace of the host machine. By binding every `veth*` interface to the `docker0` bridge, Docker creates a virtual subnet shared between the host machine and every Docker container.

View file

@ -465,7 +465,7 @@ built-in network drivers. For example:
You can inspect it, add containers too and from it, and so forth. Of course, You can inspect it, add containers too and from it, and so forth. Of course,
different plugins may make use of different technologies or frameworks. Custom different plugins may make use of different technologies or frameworks. Custom
networks can include features not present in Docker's default networks. For more networks can include features not present in Docker's default networks. For more
information on writing plugins, see [Extending Docker](../../extend) and information on writing plugins, see [Extending Docker](../../extend/index.md) and
[Writing a network driver plugin](../../extend/plugins_network.md). [Writing a network driver plugin](../../extend/plugins_network.md).
## Legacy links ## Legacy links