History

David Karlsson bc8fde23b9 doc refresh: Linux postinstall instructions (#15969 ) Signed-off-by: David Karlsson <david.karlsson@docker.com>		2022-10-26 09:08:21 +00:00
..
README.md	rename master -> main	2022-10-19 15:52:14 +02:00
app.md	lint: tidy up ordered list prefixes	2022-07-28 11:27:10 +01:00
app_bundle.md	…
app_completion.md	…
app_init.md	…
app_inspect.md	…
app_install.md	…
app_list.md	…
app_pull.md	…
app_push.md	…
app_render.md	…
app_status.md	…
app_uninstall.md	…
app_upgrade.md	…
app_validate.md	…
app_version.md	…
attach.md	…
build.md	…
builder.md	…
builder_build.md	…
builder_prune.md	…
buildx.md	…
buildx_bake.md	…
buildx_build.md	…
buildx_create.md	…
buildx_du.md	…
buildx_imagetools.md	…
buildx_imagetools_create.md	…
buildx_imagetools_inspect.md	…
buildx_inspect.md	…
buildx_install.md	add buildx install/uninstall	2021-04-07 16:12:08 +02:00
buildx_ls.md	…
buildx_prune.md	…
buildx_rm.md	…
buildx_stop.md	…
buildx_uninstall.md	add buildx install/uninstall	2021-04-07 16:12:08 +02:00
buildx_use.md	…
buildx_version.md	…
checkpoint.md	…
checkpoint_create.md	…
checkpoint_ls.md	…
checkpoint_rm.md	…
commit.md	…
compose.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_build.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_convert.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_cp.md	document compose.v2 new repository and RC3 release	2021-09-02 12:34:00 +02:00
compose_create.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_down.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_events.md	fix redirects	2022-07-13 18:02:43 +02:00
compose_exec.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_images.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_kill.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_logs.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_ls.md	document compose.v2 new repository and RC3 release	2021-09-02 12:34:00 +02:00
compose_pause.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_port.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_ps.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_pull.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_push.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_restart.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_rm.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_run.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_start.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_stop.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_top.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_unpause.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_up.md	Add Compose v2 reference (#14716 )	2022-06-21 13:12:05 +02:00
compose_version.md	update compose-cli reference docs	2021-09-13 23:02:40 +02:00
config.md	…
config_create.md	…
config_inspect.md	…
config_ls.md	…
config_rm.md	…
container.md	…
container_attach.md	…
container_commit.md	…
container_cp.md	…
container_create.md	…
container_diff.md	…
container_exec.md	…
container_export.md	…
container_inspect.md	…
container_kill.md	…
container_logs.md	…
container_ls.md	…
container_pause.md	…
container_port.md	…
container_prune.md	…
container_rename.md	…
container_restart.md	…
container_rm.md	…
container_run.md	…
container_start.md	…
container_stats.md	…
container_stop.md	…
container_top.md	…
container_unpause.md	…
container_update.md	…
container_wait.md	…
context.md	…
context_create.md	…
context_export.md	…
context_import.md	…
context_inspect.md	…
context_ls.md	…
context_rm.md	…
context_update.md	…
context_use.md	…
cp.md	…
create.md	…
diff.md	…
docker.md	Remove docker registry CLI reference	2021-06-03 00:44:25 +01:00
events.md	…
exec.md	…
export.md	…
history.md	…
image.md	…
image_build.md	…
image_history.md	…
image_import.md	…
image_inspect.md	…
image_load.md	…
image_ls.md	…
image_prune.md	…
image_pull.md	…
image_push.md	…
image_rm.md	…
image_save.md	…
image_tag.md	…
images.md	…
import.md	…
info.md	doc refresh: Linux postinstall instructions (#15969 )	2022-10-26 09:08:21 +00:00
inspect.md	…
kill.md	…
load.md	…
login.md	…
logout.md	…
logs.md	…
manifest.md	…
manifest_annotate.md	…
manifest_create.md	…
manifest_inspect.md	…
manifest_push.md	…
manifest_rm.md	Update engine reference for 20.10 release	2020-12-09 00:50:04 +01:00
network.md	…
network_connect.md	…
network_create.md	…
network_disconnect.md	…
network_inspect.md	…
network_ls.md	…
network_prune.md	…
network_rm.md	…
node.md	…
node_demote.md	…
node_inspect.md	…
node_ls.md	…
node_promote.md	…
node_ps.md	…
node_rm.md	…
node_update.md	…
pause.md	…
plugin.md	…
plugin_create.md	…
plugin_disable.md	…
plugin_enable.md	…
plugin_inspect.md	…
plugin_install.md	…
plugin_ls.md	…
plugin_push.md	…
plugin_rm.md	…
plugin_set.md	…
plugin_upgrade.md	…
port.md	…
ps.md	…
pull.md	…
push.md	…
rename.md	…
restart.md	…
rm.md	…
rmi.md	…
run.md	…
save.md	…
search.md	…
secret.md	…
secret_create.md	…
secret_inspect.md	…
secret_ls.md	…
secret_rm.md	…
service.md	…
service_create.md	…
service_inspect.md	…
service_logs.md	…
service_ls.md	…
service_ps.md	…
service_rm.md	…
service_rollback.md	…
service_scale.md	…
service_update.md	…
stack.md	…
stack_deploy.md	…
stack_ls.md	…
stack_ps.md	…
stack_rm.md	…
stack_services.md	…
start.md	…
stats.md	…
stop.md	…
swarm.md	…
swarm_ca.md	…
swarm_init.md	…
swarm_join-token.md	…
swarm_join.md	…
swarm_leave.md	…
swarm_unlock-key.md	…
swarm_unlock.md	…
swarm_update.md	…
system.md	…
system_df.md	…
system_events.md	…
system_info.md	…
system_prune.md	…
tag.md	…
top.md	…
trust.md	…
trust_inspect.md	…
trust_key.md	…
trust_key_generate.md	…
trust_key_load.md	…
trust_revoke.md	…
trust_sign.md	…
trust_signer.md	…
trust_signer_add.md	…
trust_signer_remove.md	…
unpause.md	…
update.md	…
version.md	…
volume.md	…
volume_create.md	…
volume_inspect.md	…
volume_ls.md	…
volume_prune.md	…
volume_rm.md	…
wait.md	…

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/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 for Docker CLI commands and https://github.com/docker/compose/tree/v2/docs/reference for Docker Compose commands. Specifically, the Markdown inside the ## Description and ## Examples headings are parsed. Submit corrections to the text in those repositories.

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/docs/tree/main/_data/engine-cli with the newly-generated files. Submit a pull request.