DockerCLI/docs
Djordje Lukic 9c0234bbcb
Output compact JSON by default for --format=json
With this change all `inspect` commands will output a compact JSON
representation of the elements, the default format (indented JSON) stays the
same.

Signed-off-by: Djordje Lukic <djordje.lukic@docker.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-15 15:42:35 +01:00
..
extend Update most links in docs to use https by default 2021-10-15 15:04:36 +08:00
reference Output compact JSON by default for --format=json 2022-03-15 15:42:35 +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 config: mark stackOrchestrator option as deprecated 2022-02-24 13:35:03 +01:00
generate.go switch to cli-docs-tool for yaml docs generation 2022-02-25 17:11:16 +01:00
go.mod switch to cli-docs-tool for yaml docs generation 2022-02-25 17:11:16 +01:00
tools.go switch to cli-docs-tool for yaml docs generation 2022-02-25 17:11:16 +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