Skip to content

Commit a4b4acc

Browse files
Fix links to subtopics in index.md files by include full path (docker#4054)
* for all links to , changed to full path Signed-off-by: Victoria Bialas <[email protected]> * fixed link in Swarm Tutorial per review comments Signed-off-by: Victoria Bialas <[email protected]>
1 parent 2ee1a61 commit a4b4acc

File tree

16 files changed

+51
-51
lines changed

16 files changed

+51
-51
lines changed

compose/compose-file/compose-file-v1.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -375,7 +375,7 @@ Links also express dependency between services in the same way as
375375
### log_driver
376376

377377
> [Version 1 file format](compose-versioning#version-1) only. In version 2 and up, use
378-
> [logging](index.md#logging).
378+
> [logging](/compose/compose-file/index.md#logging).
379379
380380
Specify a log driver. The default is `json-file`.
381381

@@ -384,7 +384,7 @@ Specify a log driver. The default is `json-file`.
384384
### log_opt
385385

386386
> [Version 1 file format](compose-versioning#version-1) only. In version 2 and up, use
387-
> [logging](index.md#logging).
387+
> [logging](/compose/compose-file/index.md#logging).
388388
389389
Specify logging options as key-value pairs. An example of `syslog` options:
390390

@@ -394,7 +394,7 @@ Specify logging options as key-value pairs. An example of `syslog` options:
394394
### net
395395

396396
> [Version 1 file format](compose-versioning.md#version-1) only. In version 2 and up, use
397-
> [network_mode](index.md#networkmode) and [networks](index.md#networks).
397+
> [network_mode](/compose/compose-file/index.md#networkmode) and [networks](/compose/compose-file/index.md#networks).
398398
399399
Network mode. Use the same values as the docker client `--net` parameter.
400400
The `container:...` form can take a service name instead of a container name or

compose/compose-file/compose-versioning.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,18 @@ These differences are explained below.
7575
### Version 1
7676

7777
Compose files that do not declare a version are considered "version 1". In those
78-
files, all the [services](index.md#service-configuration-reference) are
78+
files, all the [services](/compose/compose-file/index.md#service-configuration-reference) are
7979
declared at the root of the document.
8080

8181
Version 1 is supported by **Compose up to 1.6.x**. It will be deprecated in a
8282
future Compose release.
8383

8484
Version 1 files cannot declare named
85-
[volumes](index.md#volume-configuration-reference), [networks](index.md#network-configuration-reference) or
86-
[build arguments](index.md#args).
85+
[volumes](/compose/compose-file/index.md#volume-configuration-reference), [networks](/compose/compose-file/index.md#network-configuration-reference) or
86+
[build arguments](/compose/compose-file/index.md#args).
8787

88-
Compose does not take advantage of [networking](index.md#networking.md) when you use
89-
version 1: every container is placed on the default `bridge` network and is
88+
Compose does not take advantage of [networking](/compose/networking.md) when you
89+
use version 1: every container is placed on the default `bridge` network and is
9090
reachable from every other container at its IP address. You will need to use
9191
[links](compose-file-v1.md#links) to enable discovery between containers.
9292

@@ -225,7 +225,7 @@ several more.
225225
the [upgrading](#upgrading) guide for how to migrate away from these.
226226
(For more information on `extends`, please see [Extending services](/compose/extends.md#extending-services).)
227227

228-
- Added: [deploy](index.md#deploy)
228+
- Added: [deploy](/compose/compose-file/index.md#deploy)
229229

230230
### Version 3.3
231231

@@ -234,10 +234,10 @@ available with Docker Engine version **17.06.0+**, and higher.
234234

235235
Introduces the following additional parameters:
236236

237-
- [build `labels`](index.md#build)
238-
- [`credential_spec`](index.md#credentialspec)
239-
- [`configs`](index.md#configs)
240-
- [deploy `endpoint_mode`](index.md#endpointmode)
237+
- [build `labels`](/compose/compose-file/index.md#build)
238+
- [`credential_spec`](/compose/compose-file/index.md#credentialspec)
239+
- [`configs`](/compose/compose-file/index.md#configs)
240+
- [deploy `endpoint_mode`](/compose/compose-file/index.md#endpointmode)
241241

242242
## Upgrading
243243

@@ -248,7 +248,7 @@ several options have been removed:
248248

249249
- `volume_driver`: Instead of setting the volume driver on the service, define
250250
a volume using the
251-
[top-level `volumes` option](index.md#volume-configuration-reference)
251+
[top-level `volumes` option](/compose/compose-file/index.md#volume-configuration-reference)
252252
and specify the driver there.
253253

254254
version: "3"
@@ -262,12 +262,12 @@ several options have been removed:
262262
driver: mydriver
263263

264264
- `volumes_from`: To share a volume between services, define it using the
265-
[top-level `volumes` option](index.md#volume-configuration-reference)
265+
[top-level `volumes` option](/compose/compose-file/index.md#volume-configuration-reference)
266266
and reference it from each service that shares it using the
267-
[service-level `volumes` option](index.md#volumes-volumedriver).
267+
[service-level `volumes` option](/compose/compose-file/index.md#volumes-volumedriver).
268268

269269
- `cpu_shares`, `cpu_quota`, `cpuset`, `mem_limit`, `memswap_limit`: These
270-
have been replaced by the [resources](index.md#resources) key under
270+
have been replaced by the [resources](/compose/compose-file/index.md#resources) key under
271271
`deploy`. Note that `deploy` configuration only takes effect when using
272272
`docker stack deploy`, and is ignored by `docker-compose`.
273273

docker-for-aws/faqs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ This AWS documentation page will describe how you can tell if you have EC2-Class
4646
### Possible fixes to the EC2-Classic region issue:
4747
There are a few workarounds that you can try to get Docker for AWS up and running for you.
4848

49-
1. Create your own VPC, then [install Docker for AWS with a pre-existing VPC](index.md#install-with-an-existing-vpc).
49+
1. Create your own VPC, then [install Docker for AWS with a pre-existing VPC](/docker-for-aws/index.md#install-with-an-existing-vpc).
5050
2. Use a region that doesn't have **EC2-Classic**. The most common region with this issue is `us-east-1`. So try another region, `us-west-1`, `us-west-2`, or the new `us-east-2`. These regions will more then likely be setup with **EC2-VPC** and you will not longer have this issue.
5151
3. Create an new AWS account, all new accounts will be setup using **EC2-VPC** and will not have this problem.
5252
4. Contact AWS support to convert your **EC2-Classic** account to a **EC2-VPC** account. For more information checkout the following answer for **"Q. I really want a default VPC for my existing EC2 account. Is that possible?"** on https://aws.amazon.com/vpc/faqs/#Default_VPCs
@@ -61,7 +61,7 @@ There are a few workarounds that you can try to get Docker for AWS up and runnin
6161

6262
## Can I use my existing VPC?
6363

64-
Yes, see [install Docker for AWS with a pre-existing VPC](index.md#install-with-an-existing-vpc) for more info.
64+
Yes, see [install Docker for AWS with a pre-existing VPC](/docker-for-aws/index.md#install-with-an-existing-vpc) for more info.
6565

6666
## Recommended VPC and subnet setup
6767

docker-for-aws/release-notes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Release date: 02/16/2017
123123
**New**
124124

125125
- Docker Engine upgraded to [Docker 1.13.1](https://github.com/docker/docker/blob/master/CHANGELOG.md)
126-
- Added a second CloudFormation template that allows you to [install Docker for AWS into a pre-existing VPC](index.md#install-into-an-existing-vpc).
126+
- Added a second CloudFormation template that allows you to [install Docker for AWS into a pre-existing VPC](/docker-for-aws/index.md#install-into-an-existing-vpc).
127127
- Added Swarm wide support for [persistent storage volumes](persistent-data-volumes.md)
128128
- Added the following engine labels
129129
- **os** (linux)

docker-for-mac/install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ installers from the Stable or beta channel.
2424
Both Stable and Edge installers come with <a
2525
href="https://github.com/moby/moby/blob/master/experimental/README.md">
2626
experimental features in Docker Engine</a> enabled by default and configurable
27-
on [Docker Daemon preferences](index.md#daemon-experimental-mode) for
27+
on [Docker Daemon preferences](/docker-for-mac/index.md#daemon-experimental-mode) for
2828
experimental mode. We recommend that you disable experimental features for
2929
apps in production.
3030

docker-for-mac/networking.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ container. Note that this is what you have to do even on Linux if the container
9393
is on an overlay network, not a bridge network, as these are not routed.
9494

9595
The command to run the `nginx` webserver shown in [Getting
96-
Started](index.md#explore-the-application-and-run-examples) is an example of this.
96+
Started](/docker-for-mac/index.md#explore-the-application-and-run-examples) is an example of this.
9797

9898
```bash
9999
$ docker run -d -p 80:80 --name webserver nginx

docker-for-mac/osxfs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ By default, you can share files in `/Users/`, `/Volumes/`, `/private/`, and
5959
`/tmp` directly. To add or remove directory trees that are exported to Docker,
6060
use the **File sharing** tab in Docker preferences ![whale
6161
menu](/docker-for-mac/images/whale-x.png){: .inline} -> **Preferences** ->
62-
**File sharing**. (See [Preferences](index.md#preferences).)
62+
**File sharing**. (See [Preferences](/docker-for-mac/index.md#preferences).)
6363

6464
All other paths
6565
used in `-v` bind mounts are sourced from the Moby Linux VM running the Docker

docker-for-mac/release-notes.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -637,7 +637,7 @@ events or unexpected unmounts.
637637

638638
**New**
639639

640-
- More options when moving disk image (see [Storage location](index.md#storage-location) under Advanced preference settings)
640+
- More options when moving disk image (see [Storage location](/docker-for-mac/index.md#storage-location) under Advanced preference settings)
641641
- Filesharing and daemon table empty fields are editable
642642
- DNS forwarder ignores responses from malfunctioning servers ([docker/for-mac#1025](https://github.com/docker/for-mac/issues/1025))
643643
- DNS forwarder send all queries in parallel, process results in order
@@ -820,9 +820,9 @@ events or unexpected unmounts.
820820

821821
**New**
822822

823-
- Dedicated preference pane for advanced configuration of the docker daemon (edit daemon.json). See [[Daemon Advanced (JSON configuration file)](index.md#daemon-advanced-json-configuration-file).
823+
- Dedicated preference pane for advanced configuration of the docker daemon (edit daemon.json). See [[Daemon Advanced (JSON configuration file)](/docker-for-mac/index.md#daemon-advanced-json-configuration-file).
824824

825-
- Docker Experimental mode can be toggled. See [Daemon Basic (experimental mode and registries)](index.md#daemon-basic-experimental-mode-and-registries).
825+
- Docker Experimental mode can be toggled. See [Daemon Basic (experimental mode and registries)](/docker-for-mac/index.md#daemon-basic-experimental-mode-and-registries).
826826

827827
**Upgrades**
828828

@@ -1116,7 +1116,7 @@ events or unexpected unmounts.
11161116

11171117
**New**
11181118

1119-
* Docker for Mac is now available from 2 channels: **stable** and **beta**. New features and bug fixes will go out first in auto-updates to users in the beta channel. Updates to the stable channel are much less frequent and happen in sync with major and minor releases of the Docker engine. Only features that are well-tested and ready for production are added to the stable channel releases. For downloads of both and more information, see the [Getting Started](index.md#download-docker-for-mac).
1119+
* Docker for Mac is now available from 2 channels: **stable** and **beta**. New features and bug fixes will go out first in auto-updates to users in the beta channel. Updates to the stable channel are much less frequent and happen in sync with major and minor releases of the Docker engine. Only features that are well-tested and ready for production are added to the stable channel releases. For downloads of both and more information, see the [Getting Started](/docker-for-mac/index.md#download-docker-for-mac).
11201120

11211121
**Upgrades**
11221122

docker-for-mac/troubleshoot.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ See also, the discussion on the issue [docker/for-mac#1209](https://github.com/d
153153
If you are using mounted volumes and get runtime errors indicating an
154154
application file is not found, a volume mount is denied, or a service cannot
155155
start (e.g., with [Docker Compose](/compose/gettingstarted.md)), you might
156-
need to enable [file sharing](index.md#file-sharing).
156+
need to enable [file sharing](/docker-for-mac/index.md#file-sharing).
157157

158158
Volume mounting requires shared drives for projects that live outside of the
159159
`/Users` directory. Go to ![whale menu](/docker-for-mac/images/whale-x.png){:
@@ -257,7 +257,7 @@ know before you install](install.md#what-to-know-before-you-install).
257257
Pulling repository docker.io/library/busybox
258258
Network timed out while trying to connect to https://index.docker.io/v1/repositories/library/busybox/images. You may want to check your internet connection or if you are behind a proxy.
259259

260-
Starting with v1.12.1, 2016-09016 on the stable channel, and Beta 24 on the beta channel, a workaround is provided that auto-filters out the IPv6 addresses in DNS server lists and enables successful network accesss. For example, `2001:4860:4860::8888` would become `8.8.8.8`. So, the only workaround action needed for users is to [upgrade to Docker for Mac stable v1.12.1 or newer, or Beta 24 or newer](index.md#download-docker-for-mac).
260+
Starting with v1.12.1, 2016-09016 on the stable channel, and Beta 24 on the beta channel, a workaround is provided that auto-filters out the IPv6 addresses in DNS server lists and enables successful network accesss. For example, `2001:4860:4860::8888` would become `8.8.8.8`. So, the only workaround action needed for users is to [upgrade to Docker for Mac stable v1.12.1 or newer, or Beta 24 or newer](/docker-for-mac/install.md#download-docker-for-mac).
261261

262262
On releases with the workaround included to filter out / truncate IPv6 addresses from the DNS list, the above command should run properly:
263263

docker-for-windows/faqs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ To learn more about using Docker for Windows and Docker Machine, see
228228
### How do I run Windows containers on Docker on Windows Server 2016?
229229

230230
See [About Windows containers and Windows Server
231-
2016](index.md#about-windows-containers-and-windows-server-2016).
231+
2016](/docker-for-windows/index.md#about-windows-containers-and-windows-server-2016).
232232

233233
A full tutorial is available in [docker/labs](https://github.com/docker/labs) at
234234
[Getting Started with Windows

docker-for-windows/install.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ download installers from the **Stable** or **Edge** channel.
2626

2727
Both Stable and Edge installers come with <a
2828
href="https://github.com/moby/moby/blob/master/experimental/README.md">
29-
experimental features in Docker Engine</a> enabled by default. Experimental mode can be toggled on and off in [preferences](index.md#daemon-experimental-mode).
29+
experimental features in Docker Engine</a> enabled by default. Experimental mode can be toggled on and off in [preferences](/docker-for-windows/index.md#daemon-experimental-mode).
3030

3131
We welcome your
32-
[feedback](index.md#giving-feedback-and-getting-help) to help us improve Docker for Windows.
32+
[feedback](/docker-for-windows/index.md#giving-feedback-and-getting-help) to help us improve Docker for Windows.
3333

3434
For more about Stable and Edge channels, see the
3535
[FAQs](/docker-for-windows/faqs.md#questions-about-stable-and-edge-channels).

docker-for-windows/release-notes.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -731,9 +731,9 @@ registry access (fixes [docker/for-win#569](https://github.com/docker/for-win/is
731731
**New**
732732

733733
- Windows containers settings panel and options are working. In previous releases, settings were not implemented for [Windows containers
734-
mode](index.md#switch-between-windows-and-linux-containers-beta-feature). (See
734+
mode](/docker-for-windows/index.md#switch-between-windows-and-linux-containers-beta-feature). (See
735735
[About the Docker Windows containers specific
736-
dialogs](index.md#about-the-docker-windows-containers-specific-dialogs).)
736+
dialogs](/docker-for-windows/index.md#about-the-docker-windows-containers-specific-dialogs).)
737737
- Windows containers: Restart from the settings panel works
738738
- Windows containers: Factory default
739739
- Windows containers: `Daemon.json` can be modified
@@ -1071,7 +1071,7 @@ Unreleased. See Beta 23 for changes.
10711071

10721072
**New**
10731073

1074-
* Docker for Windows is now available from 2 channels: **stable** and **beta**. New features and bug fixes will go out first in auto-updates to users in the beta channel. Updates to the stable channel are much less frequent and happen in sync with major and minor releases of the Docker engine. Only features that are well-tested and ready for production are added to the stable channel releases. For downloads of both and more information, see the [Getting Started](index.md#download-docker-for-windows).
1074+
* Docker for Windows is now available from 2 channels: **stable** and **beta**. New features and bug fixes will go out first in auto-updates to users in the beta channel. Updates to the stable channel are much less frequent and happen in sync with major and minor releases of the Docker engine. Only features that are well-tested and ready for production are added to the stable channel releases. For downloads of both and more information, see the [Getting Started](/docker-for-windows/index.md#download-docker-for-windows).
10751075

10761076
* Removed the docker host name. Containers with exported ports are reachable via localhost.
10771077

0 commit comments

Comments
 (0)