mirror of https://github.com/docker/cli.git
071f6f9391
We publish this page on docs.docker.com, and hugo expects index pages for sections to be named _index.md. We currently rename the page when we mount it to the docs repo but might as well change the filename in the source. Also adds a linkTitle to the page, which is a shorter title that will be used in the sidebar navigation and breadcrumbs. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> |
||
---|---|---|
.. | ||
extend | ||
generate | ||
reference | ||
.gitignore | ||
README.md | ||
deprecated.md |
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