Sebastiaan van Stijn 987da09578

cli/command/volume: remove example and var for long description ...

This was the only command for which we set the "example" field; while
we could consider doing this for other commands, we need to look what's
best w.r.t. duplicating the information maintained in markdown.

Also remove the intermediate variable used for the long description,
as this was also the only location where we used one.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

2025-02-03 12:21:00 +01:00

..

attach.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

build.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

builder_build.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

builder_prune.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

builder.md

…

checkpoint_create.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

checkpoint_ls.md

…

checkpoint_rm.md

…

checkpoint.md

docs: minor editorial improvements, typo fixes

2023-12-19 17:15:38 +01:00

commit.md

docs: regenerate markdown

2024-02-21 10:40:13 +01:00

config_create.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

config_inspect.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

config_ls.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

config_rm.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

config.md

…

container_attach.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

container_commit.md

docs: refresh image versions in examples

2024-07-24 09:47:36 +02:00

container_cp.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

container_create.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

container_diff.md

docs: rename cli reference aliases to canonical

2024-01-15 11:29:30 +01:00

container_exec.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

container_export.md

docs: update internal links after refactor

2024-08-11 16:58:08 +02:00

container_inspect.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

container_kill.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

container_logs.md

docs: update internal links after refactor

2024-08-11 16:58:08 +02:00

container_ls.md

docs: update internal links after refactor

2024-08-11 16:58:08 +02:00

container_pause.md

docs: rename cli reference aliases to canonical

2024-01-15 11:29:30 +01:00

container_port.md

docs: rename cli reference aliases to canonical

2024-01-15 11:29:30 +01:00

container_prune.md

docs: Link supported Go duration strings

2024-10-07 10:37:00 +02:00

container_rename.md

docs: rename cli reference aliases to canonical

2024-01-15 11:29:30 +01:00

container_restart.md

cli/command/container: stop, restart: rename "--time" to "--timeout"

2024-09-30 09:43:54 +02:00

container_rm.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

container_run.md

run, create, connect: add support for gw-priority

2024-12-03 15:13:08 +01:00

container_start.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

container_stats.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

container_stop.md

cli/command/container: stop, restart: rename "--time" to "--timeout"

2024-09-30 09:43:54 +02:00

container_top.md

docs: rename cli reference aliases to canonical

2024-01-15 11:29:30 +01:00

container_unpause.md

docs: rename cli reference aliases to canonical

2024-01-15 11:29:30 +01:00

container_update.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

container_wait.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

container.md

…

context_create.md

docs: minor editorial improvements, typo fixes

2023-12-19 17:15:38 +01:00

context_export.md

…

context_import.md

…

context_inspect.md

…

context_ls.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

context_rm.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

context_show.md

…

context_update.md

…

context_use.md

docs: minor editorial improvements, typo fixes

2023-12-19 17:15:38 +01:00

context.md

…

cp.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

create.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

diff.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00

docker.md

docs: update docker login reference

2024-09-03 11:38:05 +02:00

events.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00

exec.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

export.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00

history.md

image/history: Add --platform flag

2024-10-10 17:00:43 +02:00

image_build.md

docs, man: remove confusing example for "--isolation"

2025-01-02 12:15:08 +01:00

image_history.md

image/history: Add --platform flag

2024-10-10 17:00:43 +02:00

image_import.md

docs: rename cli reference aliases to canonical

2024-01-15 11:29:30 +01:00

image_inspect.md

…

image_load.md

image/load: Add --platform

2024-10-10 16:35:07 +02:00

image_ls.md

image/list: Add --tree flag

2024-08-16 15:09:51 +02:00

image_prune.md

docs: Link supported Go duration strings

2024-10-07 10:37:00 +02:00

image_pull.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

image_push.md

push: Improve note message and colors

2024-07-10 11:36:40 +02:00

image_rm.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

image_save.md

image/save: Add --platform

2024-10-10 16:35:03 +02:00

image_tag.md

docs: update prose about image tag/name format

2024-10-17 12:36:32 +02:00

image.md

…

images.md

image/list: Add --tree flag

2024-08-16 15:09:51 +02:00

import.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00

index.md

docs: update links to docker cli reference

2024-07-04 10:28:53 +02:00

info.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00

inspect.md

docker inspect: add support for swarm configs

2024-10-24 18:32:32 +02:00

kill.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00

load.md

image/load: Add --platform

2024-10-10 16:35:07 +02:00

login.md

docs: fix anchor link to web-based login section

2024-09-23 13:48:33 +02:00

logout.md

…

logs.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

manifest_annotate.md

…

manifest_create.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

manifest_inspect.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

manifest_push.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

manifest_rm.md

…

manifest.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

network_connect.md

run, create, connect: add support for gw-priority

2024-12-03 15:13:08 +01:00

network_create.md

Add option '--ipv4'

2024-12-10 15:51:21 +00:00

network_disconnect.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

network_inspect.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

network_ls.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

network_prune.md

docs: Link supported Go duration strings

2024-10-07 10:37:00 +02:00

network_rm.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

network.md

…

node_demote.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

node_inspect.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

node_ls.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

node_promote.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

node_ps.md

docs: update example redis tags from 3.0.x to 7.4.x

2024-11-05 11:20:17 +01:00

node_rm.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

node_update.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

node.md

…

pause.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00

plugin_create.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

plugin_disable.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

plugin_enable.md

…

plugin_inspect.md

docs: update url scheme for reference docs

2024-02-20 21:38:50 +01:00

plugin_install.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

plugin_ls.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

plugin_push.md

docs: regenerate markdown

2024-02-21 10:40:13 +01:00

plugin_rm.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

plugin_set.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

plugin_upgrade.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

plugin.md

…

port.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00

ps.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

pull.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

push.md

push: Improve note message and colors

2024-07-10 11:36:40 +02:00

rename.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00

restart.md

cli/command/container: stop, restart: rename "--time" to "--timeout"

2024-09-30 09:43:54 +02:00

rm.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

rmi.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

run.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

save.md

image/save: Add --platform

2024-10-10 16:35:03 +02:00

search.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

secret_create.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

secret_inspect.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

secret_ls.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

secret_rm.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

secret.md

…

service_create.md

docs: update example redis tags from 3.0.x to 7.4.x

2024-11-05 11:20:17 +01:00

service_inspect.md

docs: update example redis tags from 3.0.x to 7.4.x

2024-11-05 11:20:17 +01:00

service_logs.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

service_ls.md

docs: update example redis tags from 3.0.x to 7.4.x

2024-11-05 11:20:17 +01:00

service_ps.md

docs: update example redis tags from 3.0.x to 7.4.x

2024-11-05 11:20:17 +01:00

service_rm.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

service_rollback.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

service_scale.md

docs: update example redis tags from 3.0.x to 7.4.x

2024-11-05 11:20:17 +01:00

service_update.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

service.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

stack_config.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

stack_deploy.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

stack_ls.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

stack_ps.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

stack_rm.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

stack_services.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

stack.md

…

start.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

stats.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

stop.md

cli/command/container: stop, restart: rename "--time" to "--timeout"

2024-09-30 09:43:54 +02:00

swarm_ca.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

swarm_init.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

swarm_join-token.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

swarm_join.md

…

swarm_leave.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

swarm_unlock-key.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

swarm_unlock.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

swarm_update.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

swarm.md

…

system_df.md

docs: use gh alert syntax for callouts

2024-08-16 11:02:10 +02:00

system_dial-stdio.md

…

system_events.md

docs: corrected the max events returned

2024-10-16 12:21:51 +02:00

system_info.md

docs: add documentation for CDI

2024-01-18 14:58:43 +01:00

system_prune.md

docs: Link supported Go duration strings

2024-10-07 10:37:00 +02:00

system.md

…

tag.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00

top.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00

trust_inspect.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

trust_key_generate.md

docs: minor editorial improvements, typo fixes

2023-12-19 17:15:38 +01:00

trust_key_load.md

docs: minor editorial improvements, typo fixes

2023-12-19 17:15:38 +01:00

trust_key.md

…

trust_revoke.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

trust_sign.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

trust_signer_add.md

docs: minor editorial improvements, typo fixes

2023-12-19 17:15:38 +01:00

trust_signer_remove.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

trust_signer.md

…

trust.md

…

unpause.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00

update.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00

version.md

chore: update link to docker engine api reference

2024-08-20 12:35:04 +02:00

volume_create.md

Correct typos in docs/ and man/

2024-06-06 02:15:23 +00:00

volume_inspect.md

…

volume_ls.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

volume_prune.md

chore: regenerate docs

2024-07-04 10:30:56 +02:00

volume_rm.md

cli/command/volume: remove example and var for long description

2025-02-03 12:21:00 +01:00

volume_update.md

…

volume.md

…

wait.md

docs: regenerate stubs for non-canonical commands

2024-01-15 13:49:53 +01:00