centersl/docker-docs

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

Files

History

Misty Stanley-Jones 669b51a889 Fix broken links (#2521 )

2017-03-28 16:42:44 -07:00

..

attach.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

build.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

checkpoint_create.md

Fix more broken links and images

2017-01-26 11:36:27 -08:00

checkpoint_ls.md

Fix more broken links and images

2017-01-26 11:36:27 -08:00

checkpoint_rm.md

Fix more broken links and images

2017-01-26 11:36:27 -08:00

checkpoint.md

Fixing broken links

2017-01-25 11:51:14 -08:00

commit.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

container_attach.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_commit.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_cp.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_create.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_diff.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_exec.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_export.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_inspect.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

container_kill.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

container_logs.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_ls.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

container_pause.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

container_port.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_prune.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_rename.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

container_restart.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

container_rm.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_run.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

container_start.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

container_stats.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_stop.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

container_top.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_unpause.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

container_update.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container_wait.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

container.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

cp.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

create.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

deploy.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

diff.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

docker.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

dockerd.md

Update dockerd.md

2017-01-19 23:48:13 -08:00

events.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

exec.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

export.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

history.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

image_build.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

image_history.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

image_import.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

image_inspect.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

image_load.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

image_ls.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

image_prune.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

image_pull.md

Replace deprecated MAINTAINER with LABEL (#1445 )

2017-03-01 19:54:22 -08:00

image_push.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

image_rm.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

image_save.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

image_tag.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

image.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

images.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

import.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

info.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

inspect.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

kill.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

load.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

login.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

logout.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

logs.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

network_connect.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

network_create.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

network_disconnect.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

network_inspect.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

network_ls.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

network_prune.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

network_rm.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

network.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

node_demote.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

node_inspect.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

node_ls.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

node_promote.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

node_ps.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

node_rm.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

node_update.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

node.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

pause.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

plugin_create.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

plugin_disable.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

plugin_enable.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

plugin_inspect.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

plugin_install.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

plugin_ls.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

plugin_push.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

plugin_rm.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

plugin_set.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

plugin_upgrade.md

Fix broken links (#2521 )

2017-03-28 16:42:44 -07:00

plugin.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

port.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

ps.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

pull.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

push.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

README.md

Renaming README to README.md for better display (#2467 )

2017-03-28 09:28:02 -07:00

rename.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

restart.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

rm.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

rmi.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

run.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

save.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

search.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

secret_create.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

secret_inspect.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

secret_ls.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

secret_rm.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

secret.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

service_create.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

service_inspect.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

service_logs.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

service_ls.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

service_ps.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

service_rm.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

service_scale.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

service_update.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

service.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

stack_deploy.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

stack_ls.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

stack_ps.md

Add stack_ps to the TOC

2017-01-20 16:57:40 -08:00

stack_rm.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

stack_services.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

stack.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

start.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

stats.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

stop.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

swarm_init.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

swarm_join-token.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

swarm_join.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

swarm_leave.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

swarm_unlock-key.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

swarm_unlock.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

swarm_update.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

swarm.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

system_df.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

system_events.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

system_info.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

system_prune.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

system.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

tag.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

top.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

unpause.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

update.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

version.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

volume_create.md

Remove duplicated content from CLI ref stub files

2017-02-21 09:35:45 -08:00

volume_inspect.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

volume_ls.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

volume_prune.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

volume_rm.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

volume.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -08:00

wait.md

YAML-sourced CLI refdocs

2017-01-19 11:12:55 -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/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.