docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
docs/engine/reference/commandline
History
Misty Stanley-Jones b3ca1d6120 Add 17.04 CLI refs 
Also adjust CLI stub pages and cli.md to look in a different
data folder for edge releases
 		2017-04-05 17:45:44 -07:00
..
README.md Renaming README to README.md for better display (#2467) 2017-03-28 09:28:02 -07:00
attach.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
build.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
checkpoint.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
checkpoint_create.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
checkpoint_ls.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
checkpoint_rm.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
commit.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_attach.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_commit.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_cp.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_create.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_diff.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_exec.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_export.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_inspect.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_kill.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_logs.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_ls.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_pause.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_port.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_prune.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_rename.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_restart.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_rm.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_run.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_start.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_stats.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_stop.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_top.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_unpause.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_update.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
container_wait.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
cp.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
create.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
deploy.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
diff.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
docker.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
dockerd.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
events.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
exec.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
export.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
history.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
image.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
image_build.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
image_history.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
image_import.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
image_inspect.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
image_load.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
image_ls.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
image_prune.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
image_pull.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
image_push.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
image_rm.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
image_save.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
image_tag.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
images.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
import.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
info.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
inspect.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
kill.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
load.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
login.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
logout.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
logs.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
network.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
network_connect.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
network_create.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
network_disconnect.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
network_inspect.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
network_ls.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
network_prune.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
network_rm.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
node.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
node_demote.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
node_inspect.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
node_ls.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
node_promote.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
node_ps.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
node_rm.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
node_update.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
pause.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
plugin.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
plugin_create.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
plugin_disable.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
plugin_enable.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
plugin_inspect.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
plugin_install.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
plugin_ls.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
plugin_push.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
plugin_rm.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
plugin_set.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
plugin_upgrade.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
port.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
ps.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
pull.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
push.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
rename.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
restart.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
rm.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
rmi.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
run.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
save.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
search.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
secret.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
secret_create.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
secret_inspect.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
secret_ls.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
secret_rm.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
service.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
service_create.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
service_inspect.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
service_logs.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
service_ls.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
service_ps.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
service_rm.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
service_scale.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
service_update.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
stack.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
stack_deploy.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
stack_ls.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
stack_ps.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
stack_rm.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
stack_services.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
start.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
stats.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
stop.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
swarm.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
swarm_init.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
swarm_join-token.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
swarm_join.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
swarm_leave.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
swarm_unlock-key.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
swarm_unlock.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
swarm_update.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
system.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
system_df.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
system_events.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
system_info.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
system_prune.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
tag.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
top.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
unpause.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
update.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
version.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
volume.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
volume_create.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
volume_inspect.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
volume_ls.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
volume_prune.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
volume_rm.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00
wait.md Add 17.04 CLI refs 2017-04-05 17:45:44 -07:00

README.md

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/docker/docker/tree/master/docs/reference/commandline Specifically, the Markdown inside the ## Description and ## Examples headings are parsed. Please 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.