DockerCLI/docs
Sebastiaan van Stijn b87a0c1b03
docs: build: add named anchor tags for flags
With this, the sections are linked from the "options" table when
producing the documentation on docs.docker.com

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-03-30 12:42:26 +02:00
..
extend Update most links in docs to use https by default 2021-10-15 15:04:36 +08:00
reference docs: build: add named anchor tags for flags 2022-03-30 12:42:26 +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 config: mark stackOrchestrator option as deprecated 2022-02-24 13:35:03 +01:00
generate.go gofmt with go1.17 2022-03-26 20:21:00 +01:00
go.mod switch to cli-docs-tool for yaml docs generation 2022-02-25 17:11:16 +01: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