Skip to content

Commit 0f3caac

Browse files
committed
compose: use relative markdown links
Unfortunately, the only reliable way to create internal links is to use relative links to other Markdown files. This does match the way links on GitHub work, but makes it harder to create these links. Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 0fffff2 commit 0f3caac

30 files changed

+257
-258
lines changed

compose/aspnet-mssql-compose.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Compose to set up and run the sample ASP.NET Core application using the
99
[.NET Core SDK image](https://hub.docker.com/_/microsoft-dotnet-core-sdk)
1010
with the
1111
[SQL Server on Linux image](https://hub.docker.com/_/microsoft-mssql-server).
12-
You just need to have [Docker Engine](/get-docker.md)
13-
and [Docker Compose](/compose/install.md) installed on your
12+
You just need to have [Docker Engine](../get-docker.md)
13+
and [Docker Compose](install.md) installed on your
1414
platform of choice: Linux, Mac or Windows.
1515

1616
For this sample, we create a sample .NET Core Web Application using the
@@ -25,8 +25,8 @@ configure this app to use our SQL Server database, and then create a
2525
1. Create a new directory for your application.
2626

2727
This directory is the context of your docker-compose project. For
28-
[Docker Desktop for Windows](/docker-for-windows/index.md#file-sharing) and
29-
[Docker Desktop for Mac](/docker-for-mac/index.md#file-sharing), you
28+
[Docker Desktop for Windows](../docker-for-windows/index.md#file-sharing) and
29+
[Docker Desktop for Mac](../docker-for-mac/index.md#file-sharing), you
3030
need to set up file sharing for the volume that you need to map.
3131

3232
1. Within your directory, use the `dotnet:2.1-sdk` Docker image to generate a
@@ -173,8 +173,8 @@ configure this app to use our SQL Server database, and then create a
173173
174174
1. Make sure you allocate at least 2GB of memory to Docker Engine. Here is how
175175
to do it on
176-
[Docker Desktop for Mac](/docker-for-mac/index.md#advanced) and
177-
[Docker Desktop for Windows](/docker-for-windows/index.md#advanced).
176+
[Docker Desktop for Mac](../docker-for-mac/index.md#advanced) and
177+
[Docker Desktop for Windows](../docker-for-windows/index.md#advanced).
178178
This is necessary to run the SQL Server on Linux container.
179179
180180
1. Run the `docker-compose up` command. After a few seconds, you should be able

compose/completion.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -121,5 +121,5 @@ Enjoy working with Compose faster and with fewer typos!
121121
- [Get started with Django](django.md)
122122
- [Get started with Rails](rails.md)
123123
- [Get started with WordPress](wordpress.md)
124-
- [Command line reference](/compose/reference/index.md)
125-
- [Compose file reference](/compose/compose-file/index.md)
124+
- [Command line reference](reference/index.md)
125+
- [Compose file reference](compose-file/index.md)

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

+12-12
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ cap_drop:
9999
```
100100

101101
> **Note**: These options are ignored when
102-
> [deploying a stack in swarm mode](/engine/reference/commandline/stack_deploy.md)
102+
> [deploying a stack in swarm mode](../../engine/reference/commandline/stack_deploy.md)
103103
> with a (version 3) Compose file.
104104

105105
### command
@@ -111,7 +111,7 @@ command: bundle exec thin -p 3000
111111
```
112112

113113
The command can also be a list, in a manner similar to
114-
[dockerfile](/engine/reference/builder.md#cmd):
114+
[dockerfile](../../engine/reference/builder.md#cmd):
115115

116116
```yaml
117117
command: ["bundle", "exec", "thin", "-p", "3000"]
@@ -184,7 +184,7 @@ entrypoint: /code/entrypoint.sh
184184
```
185185

186186
The entrypoint can also be a list, in a manner similar to
187-
[dockerfile](/engine/reference/builder.md#entrypoint):
187+
[dockerfile](../../engine/reference/builder.md#entrypoint):
188188

189189
```yaml
190190
entrypoint: ["php", "-d", "memory_limit=-1", "vendor/bin/phpunit"]
@@ -332,7 +332,7 @@ indefinitely. Compose does not support circular references and `docker-compose`
332332
returns an error if it encounters one.
333333

334334
For more on `extends`, see the
335-
[the extends documentation](/compose/extends.md#extending-services).
335+
[the extends documentation](../extends.md#extending-services).
336336

337337
### external_links
338338

@@ -396,7 +396,7 @@ options and tags it with the specified tag.
396396

397397
### labels
398398

399-
Add metadata to containers using [Docker labels](/config/labels-custom-metadata.md). You can use either an array or a dictionary.
399+
Add metadata to containers using [Docker labels](../../config/labels-custom-metadata.md). You can use either an array or a dictionary.
400400

401401
It's recommended that you use reverse-DNS notation to prevent your labels from conflicting with those used by other software.
402402

@@ -420,7 +420,7 @@ Link to containers in another service. Either specify both the service name and
420420
a link alias (`"SERVICE:ALIAS"`), or just the service name.
421421

422422
> Links are a legacy option. We recommend using
423-
> [networks](/compose/networking.md) instead.
423+
> [networks](../networking.md) instead.
424424

425425
```yaml
426426
web:
@@ -603,7 +603,7 @@ There are several things to note, depending on which
603603
For example, if you specify a mapping of `./foo:/data`, the `./foo` part
604604
is passed straight to the volume driver without being expanded.
605605

606-
See [Docker Volumes](/storage/volumes.md) and
606+
See [Docker Volumes](../../storage/volumes.md) and
607607
[Volume Plugins](/engine/extend/plugins_volume/) for more information.
608608

609609
### volumes_from
@@ -621,7 +621,7 @@ volumes_from:
621621
### cpu\_shares, cpu\_quota, cpuset, domainname, hostname, ipc, mac\_address, mem\_limit, memswap\_limit, mem\_swappiness, privileged, read\_only, restart, shm\_size, stdin\_open, tty, user, working\_dir
622622

623623
Each of these is a single value, analogous to its
624-
[docker run](/engine/reference/run.md) counterpart.
624+
[docker run](../../engine/reference/run.md) counterpart.
625625

626626
```yaml
627627
cpu_shares: 73
@@ -650,8 +650,8 @@ tty: true
650650

651651
## Compose documentation
652652

653-
- [User guide](/compose/index.md)
654-
- [Installing Compose](/compose/install.md)
653+
- [User guide](../index.md)
654+
- [Installing Compose](../install.md)
655655
- [Compose file versions and upgrading](compose-versioning.md)
656-
- [Samples](/samples/index.md)
657-
- [Command line reference](/compose/reference/index.md)
656+
- [Samples](../../samples/index.md)
657+
- [Command line reference](../reference/index.md)

compose/compose-file/compose-file-v2.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ build:
215215
> In your Dockerfile, if you specify `ARG` before the `FROM` instruction,
216216
> `ARG` is not available in the build instructions under `FROM`.
217217
> If you need an argument to be available in both places, also specify it under
218-
> the `FROM` instruction. Refer to the [understand how ARGS and FROM interact](/engine/reference/builder.md#understand-how-arg-and-from-interact)
218+
> the `FROM` instruction. Refer to the [understand how ARGS and FROM interact](../../engine/reference/builder.md#understand-how-arg-and-from-interact)
219219
> section in the documentation for usage details.
220220

221221
You can omit the value when specifying a build argument, in which case its value
@@ -271,7 +271,7 @@ An entry with the ip address and hostname is created in `/etc/hosts` inside cont
271271
Specify a build’s container isolation technology. On Linux, the only supported value
272272
is `default`. On Windows, acceptable values are `default`, `process` and
273273
`hyperv`. Refer to the
274-
[Docker Engine docs](/engine/reference/commandline/run.md#specify-isolation-technology-for-container---isolation)
274+
[Docker Engine docs](../../engine/reference/commandline/run.md#specify-isolation-technology-for-container---isolation)
275275
for details.
276276

277277
If unspecified, Compose will use the `isolation` value found in the service's definition
@@ -281,7 +281,7 @@ to determine the value to use for builds.
281281

282282
> Added in [version 2.1](compose-versioning.md#version-21) file format
283283

284-
Add metadata to the resulting image using [Docker labels](/config/labels-custom-metadata.md).
284+
Add metadata to the resulting image using [Docker labels](../../config/labels-custom-metadata.md).
285285
You can use either an array or a dictionary.
286286

287287
It's recommended that you use reverse-DNS notation to prevent your labels from
@@ -357,7 +357,7 @@ build:
357357
> Added in [version 2.3](compose-versioning.md#version-23) file format
358358

359359
Build the specified stage as defined inside the `Dockerfile`. See the
360-
[multi-stage build docs](/develop/develop-images/multistage-build.md) for
360+
[multi-stage build docs](../../develop/develop-images/multistage-build.md) for
361361
details.
362362

363363
```yaml
@@ -397,7 +397,7 @@ command: bundle exec thin -p 3000
397397
```
398398

399399
The command can also be a list, in a manner similar to
400-
[dockerfile](/engine/reference/builder.md#cmd):
400+
[dockerfile](../../engine/reference/builder.md#cmd):
401401

402402
```yaml
403403
command: ["bundle", "exec", "thin", "-p", "3000"]
@@ -490,7 +490,7 @@ services:
490490
>
491491
> `depends_on` does not wait for `db` and `redis` to be "ready" before
492492
> starting `web` - only until they have been started. If you need to wait
493-
> for a service to be ready, see [Controlling startup order](/compose/startup-order.md)
493+
> for a service to be ready, see [Controlling startup order](../startup-order.md)
494494
> for more on this problem and strategies for solving it.
495495

496496
> Added in [version 2.1](compose-versioning.md#version-21) file format.
@@ -572,7 +572,7 @@ entrypoint: /code/entrypoint.sh
572572
```
573573

574574
The entrypoint can also be a list, in a manner similar to
575-
[dockerfile](/engine/reference/builder.md#entrypoint):
575+
[dockerfile](../../engine/reference/builder.md#entrypoint):
576576

577577
```yaml
578578
entrypoint: ["php", "-d", "memory_limit=-1", "vendor/bin/phpunit"]
@@ -728,7 +728,7 @@ indefinitely. Compose does not support circular references and `docker-compose`
728728
returns an error if it encounters one.
729729

730730
For more on `extends`, see the
731-
[the extends documentation](/compose/extends.md#extending-services).
731+
[the extends documentation](../extends.md#extending-services).
732732

733733
### external_links
734734

@@ -776,7 +776,7 @@ host system to be added. An example of where this is useful is when multiple
776776
containers (running as different users) need to all read or write the same
777777
file on the host system. That file can be owned by a group shared by all the
778778
containers, and specified in `group_add`. See the
779-
[Docker documentation](/engine/reference/run.md#additional-groups) for more
779+
[Docker documentation](../../engine/reference/run.md#additional-groups) for more
780780
details.
781781

782782
A full example:
@@ -800,7 +800,7 @@ used.
800800

801801
Configure a check that's run to determine whether or not containers for this
802802
service are "healthy". See the docs for the
803-
[HEALTHCHECK Dockerfile instruction](/engine/reference/builder.md#healthcheck)
803+
[HEALTHCHECK Dockerfile instruction](../../engine/reference/builder.md#healthcheck)
804804
for details on how healthchecks work.
805805

806806
```yaml
@@ -889,7 +889,7 @@ services:
889889
> The default init binary that is used is [Tini](https://github.com/krallin/tini),
890890
> and is installed in `/usr/libexec/docker-init` on the daemon host. You can
891891
> configure the daemon to use a custom init binary through the
892-
> [`init-path` configuration option](/engine/reference/commandline/dockerd.md#daemon-configuration-file).
892+
> [`init-path` configuration option](../../engine/reference/commandline/dockerd.md#daemon-configuration-file).
893893

894894
### isolation
895895

@@ -898,12 +898,12 @@ services:
898898
Specify a container’s isolation technology. On Linux, the only supported value
899899
is `default`. On Windows, acceptable values are `default`, `process` and
900900
`hyperv`. Refer to the
901-
[Docker Engine docs](/engine/reference/commandline/run.md#specify-isolation-technology-for-container---isolation)
901+
[Docker Engine docs](../../engine/reference/commandline/run.md#specify-isolation-technology-for-container---isolation)
902902
for details.
903903

904904
### labels
905905

906-
Add metadata to containers using [Docker labels](/config/labels-custom-metadata.md). You can use either an array or a dictionary.
906+
Add metadata to containers using [Docker labels](../../config/labels-custom-metadata.md). You can use either an array or a dictionary.
907907

908908
It's recommended that you use reverse-DNS notation to prevent your labels from conflicting with those used by other software.
909909

@@ -942,7 +942,7 @@ the alias, or the service name if no alias was specified.
942942

943943
Links are not required to enable services to communicate - by default,
944944
any service can reach any other service at that service’s name. (See also, the
945-
[Links topic in Networking in Compose](/compose/networking.md#links).)
945+
[Links topic in Networking in Compose](../networking.md#links).)
946946

947947
Links also express dependency between services in the same way as
948948
[depends_on](#depends_on), so they determine the order of service startup.
@@ -966,7 +966,7 @@ logging:
966966

967967
The `driver` name specifies a logging driver for the service's
968968
containers, as with the ``--log-driver`` option for docker run
969-
([documented here](/config/containers/logging/configure.md)).
969+
([documented here](../../config/containers/logging/configure.md)).
970970

971971
The default value is json-file.
972972

@@ -1296,7 +1296,7 @@ web:
12961296
Specify the default number of containers to deploy for this service. Whenever
12971297
you run `docker-compose up`, Compose creates or removes containers to match
12981298
the specified number. This value can be overridden using the
1299-
[`--scale`](/compose/reference/up.md) flag.
1299+
[`--scale`](../reference/up.md) flag.
13001300

13011301
```yaml
13021302
web:
@@ -1497,7 +1497,7 @@ volumes:
14971497
> When creating bind mounts, using the long syntax requires the
14981498
> referenced folder to be created beforehand. Using the short syntax
14991499
> creates the folder on the fly if it doesn't exist.
1500-
> See the [bind mounts documentation](/storage/bind-mounts.md#differences-between--v-and---mount-behavior)
1500+
> See the [bind mounts documentation](../../storage/bind-mounts.md#differences-between--v-and---mount-behavior)
15011501
> for more information.
15021502

15031503
### volume\_driver
@@ -1518,7 +1518,7 @@ volume_driver: mydriver
15181518
> entry in the [top-level `volumes` option](#volume-configuration-reference).
15191519

15201520

1521-
See [Docker Volumes](/storage/volumes.md) and
1521+
See [Docker Volumes](../../storage/volumes.md) and
15221522
[Volume Plugins](/engine/extend/plugins_volume/) for more information.
15231523

15241524
### volumes_from
@@ -1568,7 +1568,7 @@ restart: unless-stopped
15681568
### cpu_count, cpu_percent, cpu\_shares, cpu\_period, cpu\_quota, cpus, cpuset, domainname, hostname, ipc, mac\_address, mem\_limit, memswap\_limit, mem\_swappiness, mem\_reservation, oom_kill_disable, oom_score_adj, privileged, read\_only, shm\_size, stdin\_open, tty, user, working\_dir
15691569

15701570
Each of these is a single value, analogous to its
1571-
[docker run](/engine/reference/run.md#runtime-constraints-on-resources) counterpart.
1571+
[docker run](../../engine/reference/run.md#runtime-constraints-on-resources) counterpart.
15721572

15731573
> Added in [version 2.2](compose-versioning.md#version-22) file format.
15741574
>
@@ -1646,10 +1646,10 @@ While it is possible to declare [volumes](#volumes) on the fly as part of the
16461646
service declaration, this section allows you to create named volumes that can be
16471647
reused across multiple services (without relying on `volumes_from`), and are
16481648
easily retrieved and inspected using the docker command line or API.
1649-
See the [docker volume](/engine/reference/commandline/volume_create.md)
1649+
See the [docker volume](../../engine/reference/commandline/volume_create.md)
16501650
subcommand documentation for more information.
16511651

1652-
See [use volumes](/storage/volumes.md) and [volume plugins](/engine/extend/plugins_volume/)
1652+
See [use volumes](../../storage/volumes.md) and [volume plugins](/engine/extend/plugins_volume/)
16531653
for general information on volumes.
16541654

16551655
Here's an example of a two-service setup where a database's data directory is
@@ -1752,7 +1752,7 @@ volumes:
17521752
> Added in [version 2.1](compose-versioning.md#version-21) file format.
17531753

17541754
Add metadata to containers using
1755-
[Docker labels](/config/labels-custom-metadata.md). You can use either
1755+
[Docker labels](../../config/labels-custom-metadata.md). You can use either
17561756
an array or a dictionary.
17571757

17581758
It's recommended that you use reverse-DNS notation to prevent your labels from
@@ -1801,7 +1801,7 @@ volumes:
18011801

18021802
The top-level `networks` key lets you specify networks to be created. For a full
18031803
explanation of Compose's use of Docker networking features, see the
1804-
[Networking guide](/compose/networking.md).
1804+
[Networking guide](../networking.md).
18051805

18061806
### driver
18071807

@@ -1885,7 +1885,7 @@ you can set this option to `true`.
18851885
> Added in [version 2.1](compose-versioning.md#version-21) file format.
18861886

18871887
Add metadata to containers using
1888-
[Docker labels](/config/labels-custom-metadata.md). You can use either
1888+
[Docker labels](../../config/labels-custom-metadata.md). You can use either
18891889
an array or a dictionary.
18901890

18911891
It's recommended that you use reverse-DNS notation to prevent your labels from
@@ -1991,8 +1991,8 @@ networks:
19911991

19921992
## Compose documentation
19931993

1994-
- [User guide](/compose/index.md)
1995-
- [Installing Compose](/compose/install.md)
1994+
- [User guide](../index.md)
1995+
- [Installing Compose](../install.md)
19961996
- [Compose file versions and upgrading](compose-versioning.md)
1997-
- [Samples](/samples/index.md)
1998-
- [Command line reference](/compose/reference/index.md)
1997+
- [Samples](../../samples/index.md)
1998+
- [Command line reference](../reference/index.md)

0 commit comments

Comments
 (0)