History

Johannes Großmann 5b7a6ba6e4 add docker debug cli reference (#19178 ) * add docker debug cli ref Signed-off-by: Craig Osterhout <craig.osterhout@docker.com> * feedback1 Signed-off-by: Craig Osterhout <craig.osterhout@docker.com> * remove pull Signed-off-by: Craig Osterhout <craig.osterhout@docker.com> * fix title Signed-off-by: Craig Osterhout <craig.osterhout@docker.com> * feedback2 Signed-off-by: Craig Osterhout <craig.osterhout@docker.com> * refactor: restructuring of docker debug docs * review: addressed comments * feat: add cross-links * review: addressed comments --------- Signed-off-by: Craig Osterhout <craig.osterhout@docker.com> Co-authored-by: Craig Osterhout <craig.osterhout@docker.com>		2024-01-25 16:19:27 +00:00
..
README.md	…
builder.md	…
builder_prune.md	…
buildx.md	…
buildx_bake.md	…
buildx_build.md	…
buildx_create.md	…
buildx_debug.md	chore: add redirect for old buildx_debug-shell cmd	2023-11-21 16:59:15 +01:00
buildx_debug_build.md	build: add buildx debug	2023-11-17 10:17:37 +01:00
buildx_du.md	…
buildx_imagetools.md	…
buildx_imagetools_create.md	…
buildx_imagetools_inspect.md	…
buildx_inspect.md	…
buildx_ls.md	…
buildx_prune.md	…
buildx_rm.md	…
buildx_stop.md	…
buildx_use.md	…
buildx_version.md	…
checkpoint.md	…
checkpoint_create.md	…
checkpoint_ls.md	…
checkpoint_rm.md	…
compose.md	…
compose_alpha.md	ENGDOCS-1724 (#18411 )	2023-10-12 12:49:18 +01:00
compose_alpha_dry-run.md	ENGDOCS-1724 (#18411 )	2023-10-12 12:49:18 +01:00
compose_alpha_publish.md	ENGDOCS-1724 (#18411 )	2023-10-12 12:49:18 +01:00
compose_alpha_scale.md	ENGDOCS-1724 (#18411 )	2023-10-12 12:49:18 +01:00
compose_alpha_viz.md	ENGDOCS-1724 (#18411 )	2023-10-12 12:49:18 +01:00
compose_build.md	…
compose_config.md	…
compose_cp.md	…
compose_create.md	…
compose_down.md	…
compose_events.md	…
compose_exec.md	…
compose_images.md	…
compose_kill.md	…
compose_logs.md	…
compose_ls.md	…
compose_pause.md	…
compose_port.md	…
compose_ps.md	…
compose_pull.md	…
compose_push.md	…
compose_restart.md	…
compose_rm.md	…
compose_run.md	…
compose_start.md	…
compose_stop.md	…
compose_top.md	…
compose_unpause.md	…
compose_up.md	…
compose_version.md	…
compose_wait.md	ENGDOCS-1724 (#18411 )	2023-10-12 12:49:18 +01:00
compose_watch.md	vendor: github.com/docker/compose/v2 v2.22.0	2023-10-12 11:17:06 +02:00
config.md	…
config_create.md	…
config_inspect.md	…
config_ls.md	…
config_rm.md	…
container.md	…
container_attach.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_commit.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_cp.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_create.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_diff.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_exec.md	hugo: display command aliases	2024-01-19 16:13:36 +01:00
container_export.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_inspect.md	…
container_kill.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_logs.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_ls.md	hugo: display command aliases	2024-01-19 16:13:36 +01:00
container_pause.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_port.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_prune.md	…
container_rename.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_restart.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_rm.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_run.md	hugo: display command aliases	2024-01-19 16:13:36 +01:00
container_start.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_stats.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_stop.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_top.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_unpause.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_update.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
container_wait.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
context.md	…
context_create.md	…
context_export.md	…
context_import.md	…
context_inspect.md	…
context_ls.md	…
context_rm.md	…
context_show.md	…
context_update.md	…
context_use.md	…
debug.md	add docker debug cli reference (#19178 )	2024-01-25 16:19:27 +00:00
docker.md	…
image.md	…
image_build.md	hugo: display command aliases	2024-01-19 16:13:36 +01:00
image_history.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
image_import.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
image_inspect.md	…
image_load.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
image_ls.md	hugo: display command aliases	2024-01-19 16:13:36 +01:00
image_prune.md	…
image_pull.md	hugo: display command aliases	2024-01-19 16:13:36 +01:00
image_push.md	hugo: display command aliases	2024-01-19 16:13:36 +01:00
image_rm.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
image_save.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
image_tag.md	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
init.md	docker init: add java, remove beta (#19137 )	2024-01-25 16:08:13 +00:00
inspect.md	…
login.md	…
logout.md	…
manifest.md	…
manifest_annotate.md	…
manifest_create.md	…
manifest_inspect.md	…
manifest_push.md	…
manifest_rm.md	…
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	…
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	…
scout.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_cache.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_cache_df.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_cache_prune.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_compare.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_config.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_cves.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_enroll.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_environment.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_integration.md	scout: bump cli v1.0.2	2023-09-26 10:11:22 +02:00
scout_integration_configure.md	scout: bump cli v1.0.2	2023-09-26 10:11:22 +02:00
scout_integration_delete.md	scout: bump cli v1.0.2	2023-09-26 10:11:22 +02:00
scout_integration_list.md	scout: bump cli v1.0.2	2023-09-26 10:11:22 +02:00
scout_policy.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_quickview.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_recommendations.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_repo.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_repo_disable.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_repo_enable.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_repo_list.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_sbom.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_stream.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_version.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
scout_watch.md	scout: remove early access callout	2023-10-02 13:07:14 +02:00
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_config.md	…
stack_deploy.md	…
stack_ls.md	…
stack_ps.md	…
stack_rm.md	…
stack_services.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	cli: remove alias stubs	2024-01-19 16:13:36 +01:00
system_info.md	hugo: display command aliases	2024-01-19 16:13:36 +01:00
system_prune.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	…
version.md	…
volume.md	…
volume_create.md	…
volume_inspect.md	…
volume_ls.md	…
volume_prune.md	…
volume_rm.md	…
volume_update.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.