Skip to content

Commit

Permalink
docs: update url scheme for reference docs
Browse files Browse the repository at this point in the history
Signed-off-by: David Karlsson <[email protected]>
  • Loading branch information
dvdksn committed Feb 20, 2024
1 parent e244044 commit caf7265
Show file tree
Hide file tree
Showing 21 changed files with 90 additions and 91 deletions.
4 changes: 2 additions & 2 deletions docs/extend/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ the registry.

- `entrypoint` string array

Entrypoint of the plugin, see [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#entrypoint)
Entrypoint of the plugin, see [`ENTRYPOINT`](https://docs.docker.com/reference/dockerfile/#entrypoint)

- `workdir` string

Working directory of the plugin, see [`WORKDIR`](https://docs.docker.com/engine/reference/builder/#workdir)
Working directory of the plugin, see [`WORKDIR`](https://docs.docker.com/reference/dockerfile/#workdir)

- `network` PluginNetwork

Expand Down
2 changes: 1 addition & 1 deletion docs/extend/plugins_authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Enable the authorization plugin with a dedicated command line flag in the
`--authorization-plugin=PLUGIN_ID` format. The flag supplies a `PLUGIN_ID`
value. This value can be the plugin’s socket or a path to a specification file.
Authorization plugins can be loaded without restarting the daemon. Refer
to the [`dockerd` documentation](../reference/commandline/dockerd.md#configuration-reload-behavior) for more information.
to the [`dockerd` documentation](https://docs.docker.com/reference/cli/dockerd/#configuration-reload-behavior) for more information.

```console
$ dockerd --authorization-plugin=plugin1 --authorization-plugin=plugin2,...
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/builder_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ Build an image from a Dockerfile

## Description

See [docker build](build.md) for more information.
See [docker build](image_build.md) for more information.
66 changes: 33 additions & 33 deletions docs/reference/commandline/cli.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/reference/commandline/container_attach.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,4 +164,4 @@ the following:

These `a`, `ctrl-a`, `X`, or `ctrl-\\` values are all examples of valid key
sequences. To configure a different configuration default key sequence for all
containers, see [**Configuration file** section](cli.md#configuration-files).
containers, see [**Configuration file** section](https://docs.docker.com/engine/reference/commandline/cli/#configuration-files).
2 changes: 1 addition & 1 deletion docs/reference/commandline/container_cp.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ $ docker cp CONTAINER:/var/logs/app.log - | tar x -O | grep "ERROR"
### Corner cases

It isn't possible to copy certain system files such as resources under
`/proc`, `/sys`, `/dev`, [tmpfs](run.md#tmpfs), and mounts created by
`/proc`, `/sys`, `/dev`, [tmpfs](container_run.md#tmpfs), and mounts created by
the user in the container. However, you can still copy such files by manually
running `tar` in `docker exec`. Both of the following examples do the same thing
in different ways (consider `SRC_PATH` and `DEST_PATH` are directories):
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/commandline/container_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,8 @@ so that it's ready to start when you need it. The initial status of the
new container is `created`.

The `docker create` command shares most of its options with the `docker run`
command (which performs a `docker create` before starting it). Refer to the
[`docker run` command](run.md) section and the [Docker run reference](../run.md)
command (which performs a `docker create` before starting it).
Refer to the [`docker run` CLI reference](container_run.md)
for details on the available flags and options.

## Examples
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/commandline/container_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -787,7 +787,7 @@ the following:

These `a`, `ctrl-a`, `X`, or `ctrl-\\` values are all examples of valid key
sequences. To configure a different configuration default key sequence for all
containers, see [**Configuration file** section](cli.md#configuration-files).
containers, see [**Configuration file** section](https://docs.docker.com/engine/reference/commandline/cli/#configuration-files).

### <a name="device"></a> Add host device to container (--device)

Expand Down Expand Up @@ -888,7 +888,7 @@ This starts an `ubuntu` container with access to the specified CDI device,
on the system running the daemon, in one of the configured CDI specification
directories.
- The CDI feature has been enabled on the daemon side, see [Enable CDI
devices](dockerd.md#enable-cdi-devices).
devices](https://docs.docker.com/reference/cli/dockerd/#enable-cdi-devices).

### <a name="attach"></a> Attach to STDIN/STDOUT/STDERR (-a, --attach)

Expand Down Expand Up @@ -1306,7 +1306,7 @@ container to exit. This signal can be a signal name in the format `SIG<NAME>`,
for instance `SIGKILL`, or an unsigned number that matches a position in the
kernel's syscall table, for instance `9`.

The default value is defined by [`STOPSIGNAL`](https://docs.docker.com/engine/reference/builder/#stopsignal)
The default value is defined by [`STOPSIGNAL`](https://docs.docker.com/reference/dockerfile/#stopsignal)
in the image, or `SIGTERM` if the image has no `STOPSIGNAL` defined.

### <a name="security-opt"></a> Optional security options (--security-opt)
Expand Down
22 changes: 11 additions & 11 deletions docs/reference/commandline/image_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Build an image from a Dockerfile
The `docker build` command builds Docker images from a Dockerfile and a
"context". A build's context is the set of files located in the specified
`PATH` or `URL`. The build process can refer to any of the files in the
context. For example, your build can use a [*COPY*](https://docs.docker.com/engine/reference/builder/#copy)
context. For example, your build can use a [*COPY*](https://docs.docker.com/reference/dockerfile/#copy)
instruction to reference a file in the context.

The `URL` parameter can refer to three kinds of resources: Git repositories,
Expand Down Expand Up @@ -144,7 +144,7 @@ In most cases, it's best to put each Dockerfile in an empty directory. Then,
add to that directory only the files needed for building the Dockerfile. To
increase the build's performance, you can exclude files and directories by
adding a `.dockerignore` file to that directory as well. For information on
creating one, see the [.dockerignore file](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
creating one, see the [.dockerignore file](https://docs.docker.com/reference/dockerfile/#dockerignore-file).

If the Docker client loses connection to the daemon, it cancels the build.
This happens if you interrupt the Docker client with `CTRL-c` or if the Docker
Expand Down Expand Up @@ -172,7 +172,7 @@ $ echo $?

See also:

[*Dockerfile Reference*](https://docs.docker.com/engine/reference/builder/).
[*Dockerfile Reference*](https://docs.docker.com/reference/dockerfile/).

## Examples

Expand Down Expand Up @@ -213,7 +213,7 @@ where to find the files for the "context" of the build on the Docker daemon.
Remember that the daemon could be running on a remote machine and that no
parsing of the Dockerfile happens at the client side (where you're running
`docker build`). That means that all the files at `PATH` are sent, not just
the ones listed to [`ADD`](https://docs.docker.com/engine/reference/builder/#add)
the ones listed to [`ADD`](https://docs.docker.com/reference/dockerfile/#add)
in the Dockerfile.

The transfer of context from the local machine to the Docker daemon is what the
Expand Down Expand Up @@ -302,7 +302,7 @@ Successfully built 99cc1ad10469
This example shows the use of the `.dockerignore` file to exclude the `.git`
directory from the context. You can see its effect in the changed size of the
uploaded context. The builder reference contains detailed information on
[creating a .dockerignore file](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
[creating a .dockerignore file](https://docs.docker.com/reference/dockerfile/#dockerignore-file).

When using the [BuildKit backend](https://docs.docker.com/build/buildkit/),
`docker build` searches for a `.dockerignore` file relative to the Dockerfile
Expand Down Expand Up @@ -384,12 +384,12 @@ the command line.
### <a name="cgroup-parent"></a> Use a custom parent cgroup (--cgroup-parent)

When you run `docker build` with the `--cgroup-parent` option, the daemon runs the containers
used in the build with the [corresponding `docker run` flag](../run.md#specify-custom-cgroups).
used in the build with the [corresponding `docker run` flag](container_run.md#cgroup-parent).

### <a name="ulimit"></a> Set ulimits in container (--ulimit)

Using the `--ulimit` option with `docker build` causes the daemon to start each build step's
container using those [`--ulimit` flag values](run.md#ulimit).
container using those [`--ulimit` flag values](container_run.md#ulimit).

### <a name="build-arg"></a> Set build-time variables (--build-arg)

Expand All @@ -415,7 +415,7 @@ Using this flag doesn't alter the output you see when the build process echoes t
Dockerfile.

For detailed information on using `ARG` and `ENV` instructions, see the
[Dockerfile reference](https://docs.docker.com/engine/reference/builder/).
[Dockerfile reference](https://docs.docker.com/reference/dockerfile/).

You can also use the `--build-arg` flag without a value, in which case the daemon
propagates the value from the local environment into the Docker container it's building:
Expand All @@ -425,7 +425,7 @@ $ export HTTP_PROXY=http://10.20.30.2:1234
$ docker build --build-arg HTTP_PROXY .
```

This example is similar to how `docker run -e` works. Refer to the [`docker run` documentation](run.md#env)
This example is similar to how `docker run -e` works. Refer to the [`docker run` documentation](container_run.md#env)
for more information.

### <a name="security-opt"></a> Optional security options (--security-opt)
Expand Down Expand Up @@ -553,7 +553,7 @@ $ docker build -o - . > out.tar

The `--output` option exports all files from the target stage. A common pattern
for exporting only specific files is to do multi-stage builds and to copy the
desired files to a new scratch stage with [`COPY --from`](https://docs.docker.com/engine/reference/builder/#copy).
desired files to a new scratch stage with [`COPY --from`](https://docs.docker.com/reference/dockerfile/#copy).

The example, the `Dockerfile` below uses a separate stage to collect the
build artifacts for exporting:
Expand Down Expand Up @@ -642,7 +642,7 @@ Available options for the networking mode are:
- `none`: Run with no network access.
- `host`: Run in the host’s network environment.

Find more details in the [Dockerfile documentation](https://docs.docker.com/engine/reference/builder/#run---network).
Find more details in the [Dockerfile documentation](https://docs.docker.com/reference/dockerfile/#run---network).

### <a name="squash"></a> Squash an image's layers (--squash) (experimental)

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/commandline/image_pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ use `docker pull`.

If you are behind an HTTP proxy server, for example in corporate settings,
before open a connect to registry, you may need to configure the Docker
daemon's proxy settings, refer to the [dockerd command-line reference](dockerd.md#proxy-configuration)
daemon's proxy settings, refer to the [dockerd command-line reference](https://docs.docker.com/reference/cli/dockerd/#proxy-configuration)
for details.

### Concurrent downloads

By default the Docker daemon will pull three layers of an image at a time.
If you are on a low bandwidth connection this may cause timeout issues and you may want to lower
this via the `--max-concurrent-downloads` daemon option. See the
[daemon documentation](dockerd.md) for more details.
[daemon documentation](https://docs.docker.com/reference/cli/dockerd/) for more details.

## Examples

Expand Down Expand Up @@ -184,7 +184,7 @@ Registry credentials are managed by [docker login](login.md).

Docker uses the `https://` protocol to communicate with a registry, unless the
registry is allowed to be accessed over an insecure connection. Refer to the
[insecure registries](dockerd.md#insecure-registries) section for more information.
[insecure registries](https://docs.docker.com/reference/cli/dockerd/#insecure-registries) section for more information.


### <a name="all-tags"></a> Pull a repository with multiple images (-a, --all-tags)
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/image_push.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Registry credentials are managed by [docker login](login.md).
By default the Docker daemon will push five layers of an image at a time.
If you are on a low bandwidth connection this may cause timeout issues and you may want to lower
this via the `--max-concurrent-uploads` daemon option. See the
[daemon documentation](dockerd.md) for more details.
[daemon documentation](https://docs.docker.com/reference/cli/dockerd/) for more details.

## Examples

Expand Down
3 changes: 1 addition & 2 deletions docs/reference/commandline/image_tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@ underscores, periods, and hyphens. It can't start with a period or hyphen and
must be no longer than 128 characters. If you don't specify a tag, the command uses `latest` by default.

You can group your images together using names and tags, and then
[push](https://docs.docker.com/engine/reference/commandline/push) them to a
registry.
[push](image_push.md) them to a registry.

## Examples

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/commandline/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ identifier: "smn_cli_guide"
This section contains reference information on using Docker's command line
client. Each command has a reference page along with samples. If you are
unfamiliar with the command line, you should start by reading about how to [Use
the Docker command line](cli.md).
the Docker command line](https://docs.docker.com/engine/reference/commandline/cli/).

You start the Docker daemon with the command line. How you start the daemon
affects your Docker containers. For that reason you should also make sure to
read the [`dockerd`](dockerd.md) reference page.
read the [`dockerd`](https://docs.docker.com/reference/cli/dockerd/) reference page.

## Commands by object

### Docker management commands

| Command | Description |
| :-------------------------------- | :--------------------------------------------------- |
| [dockerd](dockerd.md) | Launch the Docker daemon |
| [dockerd](../dockerd.md) | Launch the Docker daemon |
| [inspect](inspect.md) | Return low-level information on a container or image |
| [system events](system_events.md) | Get real-time events from the server |
| [system info](system_info.md) | Display system-wide information |
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/node_ls.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS

The `label` filter matches nodes based on engine labels and on the presence of a
`label` alone or a `label` and a value. Engine labels are configured in
the [daemon configuration](dockerd.md#daemon-configuration-file). To filter on
the [daemon configuration](https://docs.docker.com/reference/cli/dockerd/#daemon-configuration-file). To filter on
Swarm `node` labels, use [`node.label` instead](#nodelabel).

The following filter matches nodes with the `foo` label regardless of its value.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/node_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ $ docker node update --label-add type=queue worker1

The labels you set for nodes using `docker node update` apply only to the node
entity within the swarm. Do not confuse them with the docker daemon labels for
[dockerd](dockerd.md).
[dockerd](https://docs.docker.com/reference/cli/dockerd/).

For more information about labels, refer to [apply custom
metadata](https://docs.docker.com/engine/userguide/labels-custom-metadata/).
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/plugin_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Create a plugin from a rootfs and configuration. Plugin data directory must cont
## Description

Creates a plugin. Before creating the plugin, prepare the plugin's root
filesystem as well as the [config.json](../../extend/config.md).
filesystem as well as the [config.json](https://docs.docker.com/engine/extend/config/).

## Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/plugin_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ in a JSON array.

### Inspect a plugin

The following example example inspects the `tiborvass/sample-volume-plugin` plugin:
The following example inspects the `tiborvass/sample-volume-plugin` plugin:

```console
$ docker plugin inspect tiborvass/sample-volume-plugin:latest
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commandline/service_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ volumes in a service:
<td>
<p>The type of mount, can be either <tt>volume</tt>, <tt>bind</tt>, <tt>tmpfs</tt>, or <tt>npipe</tt>. Defaults to <tt>volume</tt> if no type is specified.</p>
<ul>
<li><tt>volume</tt>: mounts a <a href="https://docs.docker.com/engine/reference/commandline/volume_create/">managed volume</a>
<li><tt>volume</tt>: mounts a <a href="https://docs.docker.com/reference/cli/docker/volume/create/">managed volume</a>
into the container.</li> <li><tt>bind</tt>:
bind-mounts a directory or file from the host into the container.</li>
<li><tt>tmpfs</tt>: mount a tmpfs in the container</li>
Expand Down
Loading

0 comments on commit caf7265

Please sign in to comment.