From 043f447e2e9ecb9d6f34bcee6c11f20f263baf66 Mon Sep 17 00:00:00 2001 From: Sven Dowideit Date: Mon, 23 Nov 2015 11:15:39 +1000 Subject: [PATCH] Fixes found by docs validation tool Signed-off-by: Sven Dowideit --- docs/README.md | 4 ++-- docs/articles/https/README.md | 6 ++++++ docs/installation/SUSE.md | 2 +- docs/installation/azure.md | 4 ++-- docs/installation/binaries.md | 4 ++-- docs/installation/debian.md | 2 +- docs/installation/index.md | 2 +- docs/installation/joyent.md | 2 +- docs/installation/mac.md | 2 +- docs/installation/softlayer.md | 2 +- docs/installation/windows.md | 2 +- docs/introduction/understanding-docker.md | 4 ++-- docs/misc/faq.md | 2 +- docs/misc/index.md | 4 ++-- docs/reference/api/README.md | 6 ++++++ docs/reference/builder.md | 2 +- docs/reference/commandline/cli.md | 2 +- docs/reference/commandline/index.md | 3 ++- docs/security/apparmor.md | 6 ++++++ docs/security/trust/deploying_notary.md | 2 +- docs/security/trust/trust_sandbox.md | 2 +- docs/static_files/README.md | 8 +++++++- docs/userguide/basics.md | 2 +- docs/userguide/image_management.md | 2 +- docs/userguide/index.md | 2 +- docs/userguide/networking/default_network/saveme.md | 2 +- docs/userguide/networking/dockernetworks.md | 2 +- 27 files changed, 54 insertions(+), 29 deletions(-) diff --git a/docs/README.md b/docs/README.md index 108392fd9a..26afaabb6a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -86,7 +86,7 @@ own. 6. Check your writing for style and mechanical errors. 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 checkers](http://www.hemingwayapp.com/) that can check your writing mechanics. @@ -106,7 +106,7 @@ links that are referenced in the documentation—there should be none. ## Style guide 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 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. diff --git a/docs/articles/https/README.md b/docs/articles/https/README.md index 1faca04a1a..1369913ed7 100644 --- a/docs/articles/https/README.md +++ b/docs/articles/https/README.md @@ -1,3 +1,9 @@ + + This is an initial attempt to make it easier to test the examples in the https.md diff --git a/docs/installation/SUSE.md b/docs/installation/SUSE.md index dd37062c4e..b4c11c2287 100644 --- a/docs/installation/SUSE.md +++ b/docs/installation/SUSE.md @@ -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) 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). diff --git a/docs/installation/azure.md b/docs/installation/azure.md index 865e63d1f8..f7e3ca3c06 100644 --- a/docs/installation/azure.md +++ b/docs/installation/azure.md @@ -24,10 +24,10 @@ machines on Azure: ## What next? -Continue with the [User Guide](../userguide/). +Continue with the [User Guide](../userguide/index.md). [0]: http://azure.microsoft.com/ [1]: http://azure.microsoft.com/en-us/documentation/articles/virtual-machines-docker-vm-extension/ [2]: http://azure.microsoft.com/documentation/articles/virtual-machines-docker-with-xplat-cli/ [3]: http://azure.microsoft.com/documentation/articles/virtual-machines-docker-with-portal/ -[4]: http://azure.microsoft.com/en-us/documentation/articles/virtual-machines-docker-machine/ \ No newline at end of file +[4]: http://azure.microsoft.com/en-us/documentation/articles/virtual-machines-docker-machine/ diff --git a/docs/installation/binaries.md b/docs/installation/binaries.md index f9b2d2084e..2b9496dc46 100644 --- a/docs/installation/binaries.md +++ b/docs/installation/binaries.md @@ -37,7 +37,7 @@ runtime: ## Check kernel dependencies 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. 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 $ sudo ./docker run -i -t ubuntu /bin/bash -Continue with the [User Guide](../userguide). +Continue with the [User Guide](../userguide/index.md). diff --git a/docs/installation/debian.md b/docs/installation/debian.md index b07d34e90a..365d8220bd 100644 --- a/docs/installation/debian.md +++ b/docs/installation/debian.md @@ -170,4 +170,4 @@ You must delete the user created configuration files manually. ## What next? -Continue with the [User Guide](../userguide/). +Continue with the [User Guide](../userguide/index.md). diff --git a/docs/installation/index.md b/docs/installation/index.md index d1b25836b5..1b8f5e7ad3 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -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/). ## Where to go After Installing -* [About Docker](../misc) +* [About Docker](../misc/index.md) * [Support](https://www.docker.com/support/) * [Training](https://training.docker.com//) diff --git a/docs/installation/joyent.md b/docs/installation/joyent.md index a94a50b236..dd95e85c08 100644 --- a/docs/installation/joyent.md +++ b/docs/installation/joyent.md @@ -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 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/). \ No newline at end of file +Once you are up and running with Joyent, continue with the [Docker user guide](../userguide/index.md). diff --git a/docs/installation/mac.md b/docs/installation/mac.md index de9d01b970..3ec0f0e1fb 100644 --- a/docs/installation/mac.md +++ b/docs/installation/mac.md @@ -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 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 guide](https://docs.docker.com/kitematic/userguide/). diff --git a/docs/installation/softlayer.md b/docs/installation/softlayer.md index f86a1619df..4f1836cb8b 100644 --- a/docs/installation/softlayer.md +++ b/docs/installation/softlayer.md @@ -32,5 +32,5 @@ parent = "smn_cloud" ## What next? -Continue with the [User Guide](../userguide/). +Continue with the [User Guide](../userguide/index.md). diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 5d143b26c1..935a89ce71 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -362,6 +362,6 @@ delete that file yourself. ## 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 guide](https://docs.docker.com/kitematic/userguide/). diff --git a/docs/introduction/understanding-docker.md b/docs/introduction/understanding-docker.md index 90330c4907..558649b86c 100644 --- a/docs/introduction/understanding-docker.md +++ b/docs/introduction/understanding-docker.md @@ -285,9 +285,9 @@ BSD Jails or Solaris Zones. ## Next steps ### Installing Docker -Visit the [installation section](../installation/#installation). +Visit the [installation section](../installation/index.md#installation). ### The Docker user guide -[Learn Docker in depth](../userguide/). +[Learn Docker in depth](../userguide/index.md). diff --git a/docs/misc/faq.md b/docs/misc/faq.md index 08e48e8fb0..6e1edef3d3 100644 --- a/docs/misc/faq.md +++ b/docs/misc/faq.md @@ -269,4 +269,4 @@ You can find more answers on: - [Ask questions on Stackoverflow](http://stackoverflow.com/search?q=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). diff --git a/docs/misc/index.md b/docs/misc/index.md index 6edf7a974b..9111856315 100644 --- a/docs/misc/index.md +++ b/docs/misc/index.md @@ -83,14 +83,14 @@ The [Understanding Docker section](../introduction/understanding-docker.md) will ### 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. ### Docker user guide 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 diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md index ec1cbcb2c3..3648522344 100644 --- a/docs/reference/api/README.md +++ b/docs/reference/api/README.md @@ -1,3 +1,9 @@ + + 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 diff --git a/docs/reference/builder.md b/docs/reference/builder.md index 7c0e54d249..55c0062582 100644 --- a/docs/reference/builder.md +++ b/docs/reference/builder.md @@ -1204,7 +1204,7 @@ or a signal name in the format SIGNAME, for instance SIGKILL. ## Dockerfile examples 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 diff --git a/docs/reference/commandline/cli.md b/docs/reference/commandline/cli.md index 573015d01b..4d1a0c7961 100644 --- a/docs/reference/commandline/cli.md +++ b/docs/reference/commandline/cli.md @@ -31,7 +31,7 @@ each `docker` command with `sudo`. To avoid having to use `sudo` with the `docker` and add users to it. 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 diff --git a/docs/reference/commandline/index.md b/docs/reference/commandline/index.md index 8fe6b1a235..21d669a73a 100644 --- a/docs/reference/commandline/index.md +++ b/docs/reference/commandline/index.md @@ -7,7 +7,8 @@ keywords = ["Docker, Docker documentation, CLI, command line"] identifier= "smn_cli" parent = "mn_reference" +++ - + + # The Docker commands diff --git a/docs/security/apparmor.md b/docs/security/apparmor.md index 0743694644..07cd62c772 100644 --- a/docs/security/apparmor.md +++ b/docs/security/apparmor.md @@ -1,3 +1,9 @@ + + AppArmor security profiles for Docker -------------------------------------- diff --git a/docs/security/trust/deploying_notary.md b/docs/security/trust/deploying_notary.md index 7748c6f92f..68e57fb794 100644 --- a/docs/security/trust/deploying_notary.md +++ b/docs/security/trust/deploying_notary.md @@ -10,7 +10,7 @@ parent= "smn_content_trust" # 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 diff --git a/docs/security/trust/trust_sandbox.md b/docs/security/trust/trust_sandbox.md index 9d6c2f2120..1e017acc00 100644 --- a/docs/security/trust/trust_sandbox.md +++ b/docs/security/trust/trust_sandbox.md @@ -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 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/). Finally, you'll need to have `git` installed on your local system or VM. diff --git a/docs/static_files/README.md b/docs/static_files/README.md index f09a25af49..0b93167bde 100644 --- a/docs/static_files/README.md +++ b/docs/static_files/README.md @@ -1,3 +1,9 @@ + + Static files dir ================ @@ -8,4 +14,4 @@ Be careful not to override pre-existing static files from the template. Generally, layout related files should go in the /theme directory. If you want to add images to your particular documentation page. Just put them next to -your .rst source file and reference them relatively. \ No newline at end of file +your .rst source file and reference them relatively. diff --git a/docs/userguide/basics.md b/docs/userguide/basics.md index 42102b7423..863ece5d20 100644 --- a/docs/userguide/basics.md +++ b/docs/userguide/basics.md @@ -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. 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 diff --git a/docs/userguide/image_management.md b/docs/userguide/image_management.md index 447b3c57ab..169ffade06 100644 --- a/docs/userguide/image_management.md +++ b/docs/userguide/image_management.md @@ -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 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 or for private registries. diff --git a/docs/userguide/index.md b/docs/userguide/index.md index 2813de6dd6..2dd188d4f2 100644 --- a/docs/userguide/index.md +++ b/docs/userguide/index.md @@ -10,7 +10,7 @@ parent = "mn_fun_docker" # 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 integrating it into your environment. You'll learn how to use Docker to: diff --git a/docs/userguide/networking/default_network/saveme.md b/docs/userguide/networking/default_network/saveme.md index aa2652ebd9..f0ef85e8c0 100644 --- a/docs/userguide/networking/default_network/saveme.md +++ b/docs/userguide/networking/default_network/saveme.md @@ -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 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. diff --git a/docs/userguide/networking/dockernetworks.md b/docs/userguide/networking/dockernetworks.md index 24825ac601..532fab5bef 100644 --- a/docs/userguide/networking/dockernetworks.md +++ b/docs/userguide/networking/dockernetworks.md @@ -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, different plugins may make use of different technologies or frameworks. Custom 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). ## Legacy links