iSharkFly-Docs
/
Docker-Docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Docker-Docs/engine/reference/commandline/README.md

1.4 KiB
Raw Blame History

About these files

The files in this directory are stub files which include the file /_includes/cli.md, which parses YAML files generated from the docker/cli repository. The YAML files are parsed into output files like /engine/reference/commandline/build/.

How the output is generated

The output files are composed from two sources:

  • The Description and Usage sections comes directly from the CLI source code in that repository.

  • The Extended Description and Examples sections are pulled into the YAML from the files in https://github.com/docker/cli/tree/master/docs/reference/commandline Specifically, the Markdown inside the ## Description and ## Examples headings are parsed. Submit corrections to the text in that repository.

Updating the YAML files

The process for generating the YAML files is still in flux. Check with @thaJeztah. Be sure to generate the YAML files with the correct release branch of docker/cli, for example, the 19.03 branch.

After generating the YAML files, replace the YAML files in https://github.com/docker/docker.github.io/tree/master/_data/engine-cli with the newly-generated files. Submit a pull request.