DockerCLI/docs
Sebastiaan van Stijn df8b34595b
cli/command/container: stop, restart: rename "--time" to "--timeout"
This renames the `--time` flag as used on `docker stop` and `docker restart`
to `--timeout`,  bringing it in line with other uses for this property,
such as `--stop-timeout` on `docker run`.

The `--time` option is deprecated and hidden, but will be kept for
backward compatibility, as these options existed for a long time.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-09-30 09:43:54 +02:00
..
extend docs: rename plugins index file and add linkTitle 2024-09-04 13:48:37 +02:00
generate docs: fix typos and version for cli-docs-tool scripts 2024-07-17 15:25:37 +02:00
reference cli/command/container: stop, restart: rename "--time" to "--timeout" 2024-09-30 09:43:54 +02: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 cli/command/container: stop, restart: rename "--time" to "--timeout" 2024-09-30 09:43:54 +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