DockerCLI/docs
Noah Silas 9d5a2a6b66
docs: Correct `run` exit code 126 description
The command to run inside the container is `/etc`. The semicolon is a
statement terminator, which ends the command `docker run busybox /etc`,
while `echo $?` prints the exit code of that full docker command.

Having this mistake could confuse someone who thinks that `/etc; echo
$?` is all run inside the container, which wouldn't help the reader
understand the exit code of the `docker run` command itself.

Signed-off-by: Noah Silas <noah@hustle.com>
(cherry picked from commit 0c999fe95b)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-11-13 23:37:10 +01:00
..
extend docs: rename plugins index file and add linkTitle 2024-09-09 10:33:23 +02:00
generate docs: fix typos and version for cli-docs-tool scripts 2024-07-19 02:04:44 +02:00
reference docs: Correct `run` exit code 126 description 2024-11-13 23:37:10 +01:00
.gitignore switch to cli-docs-tool for yaml docs generation 2022-02-25 17:11:16 +01:00
README.md switch to cli-docs-tool for yaml docs generation 2022-02-25 17:11:16 +01:00
deprecated.md chore: fix style/lint issues in deprecated.md 2024-09-09 10:54:29 +02:00

README.md

The non-reference docs have been moved!

The documentation for Docker Engine has been merged into the general documentation repo.

See the README for instructions on contributing to and building the documentation.

If you'd like to edit the current published version of the Engine docs, do it in the master branch here: https://github.com/docker/docker.github.io/tree/master/engine

If you need to document the functionality of an upcoming Engine release, use the vnext-engine branch: https://github.com/docker/docker.github.io/tree/vnext-engine/engine

The reference docs have been left in docker/docker (this repo), which remains the place to edit them.

The docs in the general repo are open-source and we appreciate your feedback and pull requests!

Generate docs

$ make -f docker.Makefile yamldocs