mirror of
https://github.com/docker/cli.git
synced 2025-11-24 06:21:16 +03:00
a650f4ddd0
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com> switch to cli-docs-tool and validate yamldocs Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
# The non-reference docs have been moved!
|
|
|
|
<!-- This file is maintained within the docker/cli GitHub
|
|
repository at https://github.com/docker/cli/. Make all
|
|
pull requests against that repo. If you see this file in
|
|
another repository, consider it read-only there, as it will
|
|
periodically be overwritten by the definitive file. Pull
|
|
requests which include edits to this file in other repositories
|
|
will be rejected.
|
|
-->
|
|
|
|
The documentation for Docker Engine has been merged into
|
|
[the general documentation repo](https://github.com/docker/docker.github.io).
|
|
|
|
See the [README](https://github.com/docker/docker.github.io/blob/master/README.md)
|
|
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
|
|
|
|
```shell
|
|
$ make -f docker.Makefile yamldocs
|
|
```
|