Browse code

Fixes found by docs validation tool

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Sven Dowideit authored on 2015/11/23 10:15:39
Showing 27 changed files
... ...
@@ -86,7 +86,7 @@ own.
86 86
 6.  Check your writing for style and mechanical errors.
87 87
 
88 88
 	Use our [documentation style
89
-	guide](doc-style.md) to check style. There are
89
+	guide](/opensource/doc-style.md) to check style. There are
90 90
 	several [good grammar and spelling online
91 91
 	checkers](http://www.hemingwayapp.com/) that can check your writing
92 92
 	mechanics.
... ...
@@ -106,7 +106,7 @@ links that are referenced in the documentation&mdash;there should be none.
106 106
 ## Style guide
107 107
 
108 108
 If you have questions about how to write for Docker's documentation, please see
109
-the [style guide](doc-style.md). The style guide provides
109
+the [style guide](/opensource/doc-style.md). The style guide provides
110 110
 guidance about grammar, syntax, formatting, styling, language, or tone. If
111 111
 something isn't clear in the guide, please submit an issue to let us know or
112 112
 submit a pull request to help us improve it.
... ...
@@ -1,3 +1,9 @@
1
+<!--[metadata]>
2
+draft = true
3
+<![end-metadata]-->
4
+
1 5
 
2 6
 
3 7
 This is an initial attempt to make it easier to test the examples in the https.md
... ...
@@ -113,4 +113,4 @@ You can find more details about Docker on openSUSE or SUSE Linux Enterprise in t
113 113
 [Docker quick start guide](https://www.suse.com/documentation/sles-12/dockerquick/data/dockerquick.html)
114 114
 on the SUSE website. The document targets SUSE Linux Enterprise, but its contents apply also to openSUSE.
115 115
 
116
-Continue to the [User Guide](../userguide/).
116
+Continue to the [User Guide](../userguide/index.md).
... ...
@@ -24,10 +24,10 @@ machines on Azure:
24 24
 
25 25
 ## What next?
26 26
 
27
-Continue with the [User Guide](../userguide/).
27
+Continue with the [User Guide](../userguide/index.md).
28 28
 
29 29
 [0]: http://azure.microsoft.com/
30 30
 [1]: http://azure.microsoft.com/en-us/documentation/articles/virtual-machines-docker-vm-extension/
31 31
 [2]: http://azure.microsoft.com/documentation/articles/virtual-machines-docker-with-xplat-cli/
32 32
 [3]: http://azure.microsoft.com/documentation/articles/virtual-machines-docker-with-portal/
33
-[4]: http://azure.microsoft.com/en-us/documentation/articles/virtual-machines-docker-machine/
34 33
\ No newline at end of file
34
+[4]: http://azure.microsoft.com/en-us/documentation/articles/virtual-machines-docker-machine/
... ...
@@ -37,7 +37,7 @@ runtime:
37 37
 ## Check kernel dependencies
38 38
 
39 39
 Docker in daemon mode has specific kernel requirements. For details,
40
-check your distribution in [*Installation*](../installation#installation-list).
40
+check your distribution in [*Installation*](index.md#on-linux).
41 41
 
42 42
 A 3.10 Linux kernel is the minimum requirement for Docker.
43 43
 Kernels older than 3.10 lack some of the features required to run Docker
... ...
@@ -211,4 +211,4 @@ Then follow the regular installation steps.
211 211
     # run a container and open an interactive shell in the container
212 212
     $ sudo ./docker run -i -t ubuntu /bin/bash
213 213
 
214
-Continue with the [User Guide](../userguide).
214
+Continue with the [User Guide](../userguide/index.md).
... ...
@@ -170,4 +170,4 @@ You must delete the user created configuration files manually.
170 170
 
171 171
 ## What next?
172 172
 
173
-Continue with the [User Guide](../userguide/).
173
+Continue with the [User Guide](../userguide/index.md).
... ...
@@ -42,7 +42,7 @@ Instructions for installing prior releases of Docker can be found in the followi
42 42
 [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/).
43 43
 
44 44
 ## Where to go After Installing
45
-* [About Docker](../misc)
45
+* [About Docker](../misc/index.md)
46 46
 * [Support](https://www.docker.com/support/)
47 47
 * [Training](https://training.docker.com//)
48 48
 
... ...
@@ -20,4 +20,4 @@ Joyent provides a `sdc-docker-setup.sh` script that makes it easy to use Docker
20 20
 with Joyent. The [Docker API guide for
21 21
 Triton](https://apidocs.joyent.com/docker) has details on using this script.
22 22
 
23
-Once you are up and running with Joyent, continue with the [Docker user guide](../userguide/). 
24 23
\ No newline at end of file
24
+Once you are up and running with Joyent, continue with the [Docker user guide](../userguide/index.md). 
... ...
@@ -425,6 +425,6 @@ Use `docker-machine help` to list the full command line reference for Docker Mac
425 425
 information about using SSH or SCP to access a VM, see [the Docker Machine
426 426
 documentation](https://docs.docker.com/machine/).
427 427
 
428
-You can continue with the [Docker User Guide](../userguide). If you are
428
+You can continue with the [Docker User Guide](../userguide/index.md). If you are
429 429
 interested in using the Kitematic GUI, see the [Kitematic user
430 430
 guide](https://docs.docker.com/kitematic/userguide/).
... ...
@@ -32,5 +32,5 @@ parent = "smn_cloud"
32 32
 
33 33
 ## What next?
34 34
 
35
-Continue with the [User Guide](../userguide/).
35
+Continue with the [User Guide](../userguide/index.md).
36 36
 
... ...
@@ -362,6 +362,6 @@ delete that file yourself.
362 362
 
363 363
 ## Learn more
364 364
 
365
-You can continue with the [Docker User Guide](../userguide). If you are
365
+You can continue with the [Docker User Guide](../userguide/index.md). If you are
366 366
 interested in using the Kitematic GUI, see the [Kitematic user
367 367
 guide](https://docs.docker.com/kitematic/userguide/).
... ...
@@ -285,9 +285,9 @@ BSD Jails or Solaris Zones.
285 285
 
286 286
 ## Next steps
287 287
 ### Installing Docker
288
-Visit the [installation section](../installation/#installation).
288
+Visit the [installation section](../installation/index.md#installation).
289 289
 
290 290
 ### The Docker user guide
291
-[Learn Docker in depth](../userguide/).
291
+[Learn Docker in depth](../userguide/index.md).
292 292
 
293 293
 
... ...
@@ -269,4 +269,4 @@ You can find more answers on:
269 269
 - [Ask questions on Stackoverflow](http://stackoverflow.com/search?q=docker)
270 270
 - [Join the conversation on Twitter](http://twitter.com/docker)
271 271
 
272
-Looking for something else to read? Checkout the [User Guide](../userguide/).
272
+Looking for something else to read? Checkout the [User Guide](../userguide/index.md).
... ...
@@ -83,14 +83,14 @@ The [Understanding Docker section](../introduction/understanding-docker.md) will
83 83
 
84 84
 ### Installation guides
85 85
 
86
-The [installation section](../installation) will show you how to install Docker
86
+The [installation section](../installation/index.md) will show you how to install Docker
87 87
 on a variety of platforms.
88 88
 
89 89
 
90 90
 ### Docker user guide
91 91
 
92 92
 To learn about Docker in more detail and to answer questions about usage and
93
-implementation, check out the [Docker User Guide](../userguide/).
93
+implementation, check out the [Docker User Guide](../userguide/index.md).
94 94
 
95 95
 ## Release notes
96 96
 
... ...
@@ -1,3 +1,9 @@
1
+<!--[metadata]>
2
+draft = true
3
+<![end-metadata]-->
4
+
1 5
 This directory holds the authoritative specifications of APIs defined and implemented by Docker. Currently this includes:
2 6
 
3 7
  * The remote API by which a docker node can be queried over HTTP
... ...
@@ -1204,7 +1204,7 @@ or a signal name in the format SIGNAME, for instance SIGKILL.
1204 1204
 ## Dockerfile examples
1205 1205
 
1206 1206
 Below you can see some examples of Dockerfile syntax. If you're interested in
1207
-something more realistic, take a look at the list of [Dockerization examples](../examples/).
1207
+something more realistic, take a look at the list of [Dockerization examples](../examples/index.md).
1208 1208
 
1209 1209
 ```
1210 1210
 # Nginx
... ...
@@ -31,7 +31,7 @@ each `docker` command with `sudo`. To avoid having to use `sudo` with the
31 31
 `docker` and add users to it.
32 32
 
33 33
 For more information about installing Docker or `sudo` configuration, refer to
34
-the [installation](../../installation) instructions for your operating system.
34
+the [installation](../../installation/index.md) instructions for your operating system.
35 35
 
36 36
 ## Environment variables
37 37
 
... ...
@@ -7,7 +7,8 @@ keywords = ["Docker, Docker documentation, CLI,  command line"]
7 7
 identifier= "smn_cli"
8 8
 parent = "mn_reference"
9 9
 +++
10
-<!-- [end-metadata]-->
10
+<![end-metadata]-->
11
+
11 12
 
12 13
 
13 14
 # The Docker commands
... ...
@@ -1,3 +1,9 @@
1
+<!-- [metadata]>
2
+draft = true
3
+<![end-metadata]-->
4
+
1 5
 AppArmor security profiles for Docker
2 6
 --------------------------------------
3 7
 
... ...
@@ -10,7 +10,7 @@ parent= "smn_content_trust"
10 10
 
11 11
 # Deploying Notary Server with Compose
12 12
 
13
-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).
13
+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).
14 14
 
15 15
 1. Clone the Notary repository
16 16
 
... ...
@@ -25,7 +25,7 @@ have `sudo` privileges on your local machine or in the VM.
25 25
 
26 26
 This sandbox requires you to install two Docker tools: Docker Engine and Docker
27 27
 Compose. To install the Docker Engine, choose from the [list of supported
28
-platforms](../../installation). To install Docker Compose, see the
28
+platforms](../../installation/index.md). To install Docker Compose, see the
29 29
 [detailed instructions here](https://docs.docker.com/compose/install/).
30 30
 
31 31
 Finally, you'll need to have `git` installed on your local system or VM.
... ...
@@ -1,3 +1,9 @@
1
+<!--[metadata]>
2
+draft = true
3
+<![end-metadata]-->
4
+
1 5
 Static files dir
2 6
 ================
3 7
 
... ...
@@ -8,4 +14,4 @@ Be careful not to override pre-existing static files from the template.
8 8
 Generally, layout related files should go in the /theme directory.
9 9
 
10 10
 If you want to add images to your particular documentation page. Just put them next to
11
-your .rst source file and reference them relatively.
12 11
\ No newline at end of file
12
+your .rst source file and reference them relatively.
... ...
@@ -28,7 +28,7 @@ to preface each `docker` command with `sudo`. One way to avoid having to use
28 28
 add users that will be entering `docker` commands to the 'docker' group.
29 29
 
30 30
 For more information about installing Docker or `sudo` configuration, refer to
31
-the [installation](../installation) instructions for your operating system.
31
+the [installation](../installation/index.md) instructions for your operating system.
32 32
 
33 33
 
34 34
 ## Download a pre-built image
... ...
@@ -48,6 +48,6 @@ operates on. You use Docker to push and pull images (data) to a registry.
48 48
 Content trust gives you the ability to both verify the integrity and the
49 49
 publisher of all the data received from a registry over any channel.
50 50
 
51
-[Content trust](../security/trust/) is currently only available for users of the
51
+[Content trust](../security/trust/index.md) is currently only available for users of the
52 52
 public Docker Hub. It is currently not available for the Docker Trusted Registry
53 53
 or for private registries.
... ...
@@ -10,7 +10,7 @@ parent = "mn_fun_docker"
10 10
 
11 11
 # Welcome to the Docker user guide
12 12
 
13
-In the [Introduction](../misc) you got a taste of what Docker is and how it
13
+In the [Introduction](../misc/index.md) you got a taste of what Docker is and how it
14 14
 works. This guide takes you through the fundamentals of using Docker and
15 15
 integrating it into your environment. You'll learn how to use Docker to:
16 16
 
... ...
@@ -16,7 +16,7 @@ This content was extracted from the original introduction. We may want to add it
16 16
 ## A Brief introduction to networking and docker
17 17
 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`.
18 18
 
19
-> **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/).
19
+> **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).
20 20
 
21 21
 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.
22 22
 
... ...
@@ -465,7 +465,7 @@ built-in network drivers. For example:
465 465
 You can inspect it, add containers too and from it, and so forth. Of course,
466 466
 different plugins may make use of different technologies or frameworks. Custom
467 467
 networks can include features not present in Docker's default networks. For more
468
-information on writing plugins, see [Extending Docker](../../extend) and
468
+information on writing plugins, see [Extending Docker](../../extend/index.md) and
469 469
 [Writing a network driver plugin](../../extend/plugins_network.md).
470 470
 
471 471
 ## Legacy links