a4f5e30249
* Reword lots of instances of 'will' * Reword lots of instances of won't * Reword lots of instances of we'll * Eradicate you'll * Eradicate 'be able to' type of phrases * Eradicate 'unable to' type of phrases * Eradicate 'has / have to' type of phrases * Eradicate 'note that' type of phrases * Eradicate 'in order to' type of phrases * Redirect to official Chef and Puppet docs * Eradicate gratuitous 'please' * Reduce use of e.g. * Reduce use of i.e. * Reduce use of N.B. * Get rid of 'sexagesimal' and correct some errors
1.4 KiB
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/docker repository. The YAML files
are parsed into output files like
https://docs.docker.com/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/moby/moby/tree/master/docs/reference/commandline Specifically, the Markdown inside the
## Descriptionand## Examplesheadings 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
@thajestah or @frenchben. Be sure to generate the YAML files with the correct
branch of docker/docker checked out (probably not master).
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.