Skip to content
This repository was archived by the owner on Oct 13, 2023. It is now read-only.

Commit 299fb4e

Browse files
committed
reference docs: fix broken links and markdown touch-ups
- fix various broken links - fix incorrect anchors - updated links for content that moved, so that no redirect to the new location is needed. - touched-up Markdown; - re-format some JSON output - add blank line betweeen command and command output - format "note" blocks Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit 8919c228bdcd8bd366dee9589d22001c856e9e76) Signed-off-by: Sebastiaan van Stijn <github@gone.nl> Upstream-commit: 96eb0888fa6be0f087c1b177134255a104bfdf83 Component: cli
1 parent 26605e5 commit 299fb4e

57 files changed

Lines changed: 574 additions & 470 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

components/cli/docs/reference/commandline/build.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -396,13 +396,13 @@ the command line.
396396

397397
When `docker build` is run with the `--cgroup-parent` option the containers
398398
used in the build will be run with the [corresponding `docker run`
399-
flag](../run.md#specifying-custom-cgroups).
399+
flag](../run.md#specify-custom-cgroups).
400400

401401
### Set ulimits in container (--ulimit)
402402

403403
Using the `--ulimit` option with `docker build` will cause each build step's
404404
container to be started using those [`--ulimit`
405-
flag values](./run.md#set-ulimits-in-container-ulimit).
405+
flag values](run.md#set-ulimits-in-container---ulimit).
406406

407407
### Set build-time variables (--build-arg)
408408

components/cli/docs/reference/commandline/cp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ you must be explicit with a relative or absolute path, for example:
9090
`/path/to/file:name.txt` or `./file:name.txt`
9191

9292
It is not possible to copy certain system files such as resources under
93-
`/proc`, `/sys`, `/dev`, [tmpfs](run.md#mount-tmpfs-tmpfs), and mounts created by
93+
`/proc`, `/sys`, `/dev`, [tmpfs](run.md#mount-tmpfs---tmpfs), and mounts created by
9494
the user in the container. However, you can still copy such files by manually
9595
running `tar` in `docker exec`. Both of the following examples do the same thing
9696
in different ways (consider `SRC_PATH` and `DEST_PATH` are directories):

components/cli/docs/reference/commandline/import.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ $ docker import http://example.com/exampleimage.tgz
6060
- Import to docker from a local archive.
6161

6262
```bash
63-
$ docker import /path/to/exampleimage.tgz
63+
$ docker import /path/to/exampleimage.tgz
6464
```
6565

6666
### Import from a local directory
@@ -81,9 +81,12 @@ archiving with tar. If you are not root (or the sudo command) when you
8181
tar, then the ownerships might not get preserved.
8282

8383
## When the daemon supports multiple operating systems
84+
8485
If the daemon supports multiple operating systems, and the image being imported
8586
does not match the default operating system, it may be necessary to add
8687
`--platform`. This would be necessary when importing a Linux image into a Windows
8788
daemon.
8889

89-
# docker import --platform=linux .\linuximage.tar
90+
```bash
91+
$ docker import --platform=linux .\linuximage.tar
92+
```

components/cli/docs/reference/commandline/kill.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ inside the container is sent `SIGKILL` signal (default), or the signal that is
2323
specified with the `--signal` option. You can kill a container using the
2424
container's ID, ID-prefix, or name.
2525

26-
> **Note**: `ENTRYPOINT` and `CMD` in the *shell* form run as a subcommand of
26+
> **Note**
27+
>
28+
> `ENTRYPOINT` and `CMD` in the *shell* form run as a child process of
2729
> `/bin/sh -c`, which does not pass signals. This means that the executable is
2830
> not the container’s PID 1 and does not receive Unix signals.
2931

components/cli/docs/reference/commandline/logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,4 @@ $ docker logs -f --until=2s
7373
Tue 14 Nov 2017 16:40:00 CET
7474
Tue 14 Nov 2017 16:40:01 CET
7575
Tue 14 Nov 2017 16:40:02 CET
76-
```
76+
```

components/cli/docs/reference/commandline/manifest.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ to two images -- one for windows on amd64, and one for darwin on amd64.
4040

4141
### manifest inspect
4242

43-
```
43+
```bash
4444
manifest inspect --help
4545

4646
Usage: docker manifest inspect [OPTIONS] [MANIFEST_LIST] MANIFEST
@@ -275,9 +275,10 @@ $ docker manifest create --insecure myprivateregistry.mycompany.com/repo/image:1
275275
$ docker manifest push --insecure myprivateregistry.mycompany.com/repo/image:tag
276276
```
277277

278-
> **Note**: the `--insecure` flag is not required to annotate a manifest list,
278+
> **Note**
279+
>
280+
> The `--insecure` flag is not required to annotate a manifest list,
279281
> since annotations are to a locally-stored copy of a manifest list. You may also
280282
> skip the `--insecure` flag if you are performing a `docker manifest inspect`
281283
> on a locally-stored manifest list. Be sure to keep in mind that locally-stored
282284
> manifest lists are never used by the engine on a `docker pull`.
283-

components/cli/docs/reference/commandline/network.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ prune, connect, and disconnect networks.
3535

3636
* [network create](network_create.md)
3737
* [network inspect](network_inspect.md)
38-
* [network list](network_list.md)
38+
* [network list](network_ls.md)
3939
* [network rm](network_rm.md)
4040
* [network prune](network_prune.md)
4141
* [network connect](network_connect.md)

components/cli/docs/reference/commandline/network_disconnect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ disconnect it from the network.
2424
## Examples
2525

2626
```bash
27-
$ docker network disconnect multi-host-network container1
27+
$ docker network disconnect multi-host-network container1
2828
```
2929

3030

components/cli/docs/reference/commandline/network_prune.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ f949d337b1f5 none null local
9696
* [network ls](network_ls.md)
9797
* [network inspect](network_inspect.md)
9898
* [network rm](network_rm.md)
99-
* [Understand Docker container networks](https://docs.docker.com/engine/userguide/networking/)
99+
* [Understand Docker container networks](https://docs.docker.com/network/)
100100
* [system df](system_df.md)
101101
* [container prune](container_prune.md)
102102
* [image prune](image_prune.md)

components/cli/docs/reference/commandline/network_rm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ deletion.
5656
* [network ls](network_ls.md)
5757
* [network inspect](network_inspect.md)
5858
* [network prune](network_prune.md)
59-
* [Understand Docker container networks](https://docs.docker.com/engine/userguide/networking/)
59+
* [Understand Docker container networks](https://docs.docker.com/network/)

0 commit comments

Comments
 (0)