DockerCLI/docs
Sebastiaan van Stijn 35d7fbc818
docs: inspect: remove trailing whitespace from example
Current versions of the docs generator take this into account, but on
the 20.10 branch, the trailing whitespace can make the YAML generator
switch to use "compact" formatting, which is hard to read, and hard
to review diffs when updating.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-07 12:24:14 +01:00
..
extend docs/extend: remove note about first supported version 2022-12-05 17:09:57 +01:00
reference docs: inspect: remove trailing whitespace from example 2023-01-07 12:24:14 +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 docs: deprecated: fix link to Docker Desktop 3.2.0 release notes 2023-01-06 16:55:50 +01:00
generate.go docs: generate markdown 2023-01-06 22:36:47 +01:00
go.mod update cli-docs-tool to v0.5.0 2022-08-17 16:56:44 +02:00
tools.go gofmt with go1.17 2022-03-26 20:21:00 +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