DockerCLI/docs
Bjorn Neergaard 50bb59277a
docs: tidy up CDI docs
Signed-off-by: Bjorn Neergaard <bjorn.neergaard@docker.com>
(cherry picked from commit 116db4fc82)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-06-03 13:28:38 +02:00
..
extend docs: update url scheme for reference docs 2024-02-20 21:38:50 +01:00
generate cli: SetupRootCommand: remove redundant flags return 2023-06-28 16:26:50 +02:00
reference docs: tidy up CDI docs 2024-06-03 13:28:38 +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 Merge pull request #4949 from akerouanton/remove-short-cid-alias 2024-03-20 16:05:01 +01: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