mirror of https://github.com/docker/docs.git synced 2026-03-27 22:38:54 +07:00

Files

Misty Stanley-Jones a4f5e30249 Various copyedits to reduce future tense, wordiness, and use of 'please' (#5788 )

* 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

2018-01-25 17:37:23 -08:00

attach.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

build.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

checkpoint_create.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

checkpoint_ls.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

checkpoint_rm.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

checkpoint.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

commit.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

config_create.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

config_inspect.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

config_ls.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

config_rm.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

config.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_attach.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_commit.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_cp.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_create.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_diff.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_exec.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_export.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_inspect.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_kill.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_logs.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_ls.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_pause.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_port.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_prune.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_rename.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_restart.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_rm.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_run.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_start.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_stats.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_stop.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_top.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_unpause.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_update.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container_wait.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

container.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

cp.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

create.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

deploy.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

diff.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

docker.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

events.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

exec.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

export.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

history.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

image_build.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

image_history.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

image_import.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

image_inspect.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

image_load.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

image_ls.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

image_prune.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

image_pull.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

image_push.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

image_rm.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

image_save.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

image_tag.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

image.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

images.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

import.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

info.md

Add info about warnings in docker info (#5048 )

2017-10-20 09:48:10 -07:00

inspect.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

kill.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

load.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

logout.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

logs.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

network_connect.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

network_create.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

network_disconnect.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

network_inspect.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

network_ls.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

network_prune.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

network_rm.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

network.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

node_demote.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

node_inspect.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

node_ls.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

node_promote.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

node_ps.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

node_rm.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

node_update.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

node.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

pause.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

plugin_create.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

plugin_disable.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

plugin_enable.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

plugin_inspect.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

plugin_install.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

plugin_ls.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

plugin_push.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

plugin_rm.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

plugin_set.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

plugin_upgrade.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

plugin.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

port.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

ps.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

pull.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

push.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

README.md

Various copyedits to reduce future tense, wordiness, and use of 'please' (#5788 )

2018-01-25 17:37:23 -08:00

rename.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

restart.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

rm.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

rmi.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

run.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

save.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

search.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

secret_create.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

secret_inspect.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

secret_ls.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

secret_rm.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

secret.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

service_create.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

service_inspect.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

service_logs.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

service_ls.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

service_ps.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

service_rm.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

service_rollback.md

Update YAML files for CLI refs

2017-09-26 20:49:43 -07:00

service_scale.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

service_update.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

service.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

stack_deploy.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

stack_ls.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

stack_ps.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

stack_rm.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

stack_services.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

stack.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

start.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

stats.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

stop.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

swarm_ca.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

swarm_init.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

swarm_join-token.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

swarm_join.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

swarm_leave.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

swarm_unlock-key.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

swarm_unlock.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

swarm_update.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

swarm.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

system_df.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

system_events.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

system_info.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

system_prune.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

system.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

tag.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

top.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

trust_inspect.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

trust_key_generate.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

trust_key_load.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

trust_key.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

trust_revoke.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

trust_sign.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

trust_signer_add.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

trust_signer_remove.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

trust_signer.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

trust_view.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

trust.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

unpause.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

update.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

version.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

volume_create.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

volume_inspect.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

volume_ls.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

volume_prune.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

volume_rm.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

volume.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08:00

wait.md

Update CLI reference files and TOC

2018-01-02 17:13:00 -08: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/moby/moby/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 @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.