DockerCLI/docs
Yucheng Wu 5d04b1c49e
note `--user` args usage restriction
Signed-off-by: Yucheng Wu <wyc123wyc@gmail.com>
2023-01-17 22:45:23 +01:00
..
extend docs/extend: remove note about first supported version 2022-12-05 17:09:57 +01:00
reference note `--user` args usage restriction 2023-01-17 22:45:23 +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 deprecated: update deprecation for btrfs on CentOS/RHEL 7 2023-01-09 19:04:33 +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