From b30609446d212624e3d4ce814c70130b75c552a0 Mon Sep 17 00:00:00 2001 From: Misty Stanley-Jones Date: Fri, 14 Oct 2016 15:30:36 -0700 Subject: [PATCH] Convert Markdown frontmatter to YAML Some frontmatter such as the weights, menu stuff, etc is no longer used 'draft=true' becomes 'published: false' Signed-off-by: Misty Stanley-Jones --- docs/deprecated.md | 19 ++---- docs/extend/index.md | 19 ++---- docs/extend/legacy_plugins.md | 17 ++--- docs/extend/manifest.md | 67 +++++++++---------- docs/extend/menu.md | 19 ++---- docs/extend/plugin_api.md | 15 ++--- docs/extend/plugins_authorization.md | 17 ++--- docs/extend/plugins_network.md | 15 ++--- docs/extend/plugins_volume.md | 15 ++--- docs/reference/api/README.md | 8 +-- docs/reference/api/docker-io_api.md | 17 ++--- docs/reference/api/docker_io_accounts_api.md | 15 ++--- docs/reference/api/docker_remote_api.md | 15 ++--- docs/reference/api/docker_remote_api_v1.18.md | 15 ++--- docs/reference/api/docker_remote_api_v1.19.md | 15 ++--- docs/reference/api/docker_remote_api_v1.20.md | 15 ++--- docs/reference/api/docker_remote_api_v1.21.md | 15 ++--- docs/reference/api/docker_remote_api_v1.22.md | 15 ++--- docs/reference/api/docker_remote_api_v1.23.md | 17 ++--- docs/reference/api/docker_remote_api_v1.24.md | 17 ++--- docs/reference/api/docker_remote_api_v1.25.md | 17 ++--- docs/reference/api/hub_registry_spec.md | 16 ++--- docs/reference/api/index.md | 16 ++--- .../api/remote_api_client_libraries.md | 15 ++--- docs/reference/builder.md | 17 ++--- docs/reference/commandline/attach.md | 14 ++-- docs/reference/commandline/build.md | 14 ++-- docs/reference/commandline/cli.md | 17 ++--- docs/reference/commandline/commit.md | 14 ++-- docs/reference/commandline/container_prune.md | 14 ++-- docs/reference/commandline/cp.md | 14 ++-- docs/reference/commandline/create.md | 14 ++-- docs/reference/commandline/deploy.md | 16 ++--- docs/reference/commandline/diff.md | 14 ++-- docs/reference/commandline/dockerd.md | 17 ++--- docs/reference/commandline/events.md | 14 ++-- docs/reference/commandline/exec.md | 14 ++-- docs/reference/commandline/export.md | 14 ++-- docs/reference/commandline/history.md | 14 ++-- docs/reference/commandline/image_prune.md | 14 ++-- docs/reference/commandline/images.md | 14 ++-- docs/reference/commandline/import.md | 14 ++-- docs/reference/commandline/index.md | 17 ++--- docs/reference/commandline/info.md | 14 ++-- docs/reference/commandline/inspect.md | 14 ++-- docs/reference/commandline/kill.md | 14 ++-- docs/reference/commandline/load.md | 14 ++-- docs/reference/commandline/login.md | 14 ++-- docs/reference/commandline/logout.md | 14 ++-- docs/reference/commandline/logs.md | 14 ++-- docs/reference/commandline/menu.md | 17 ++--- docs/reference/commandline/network_connect.md | 14 ++-- docs/reference/commandline/network_create.md | 14 ++-- .../commandline/network_disconnect.md | 14 ++-- docs/reference/commandline/network_inspect.md | 14 ++-- docs/reference/commandline/network_ls.md | 14 ++-- docs/reference/commandline/network_rm.md | 14 ++-- docs/reference/commandline/node_demote.md | 14 ++-- docs/reference/commandline/node_inspect.md | 14 ++-- docs/reference/commandline/node_ls.md | 14 ++-- docs/reference/commandline/node_promote.md | 14 ++-- docs/reference/commandline/node_ps.md | 16 ++--- docs/reference/commandline/node_rm.md | 14 ++-- docs/reference/commandline/node_update.md | 14 ++-- docs/reference/commandline/pause.md | 14 ++-- docs/reference/commandline/plugin_disable.md | 16 ++--- docs/reference/commandline/plugin_enable.md | 16 ++--- docs/reference/commandline/plugin_inspect.md | 16 ++--- docs/reference/commandline/plugin_install.md | 16 ++--- docs/reference/commandline/plugin_ls.md | 16 ++--- docs/reference/commandline/plugin_rm.md | 16 ++--- docs/reference/commandline/port.md | 14 ++-- docs/reference/commandline/ps.md | 14 ++-- docs/reference/commandline/pull.md | 14 ++-- docs/reference/commandline/push.md | 14 ++-- docs/reference/commandline/rename.md | 14 ++-- docs/reference/commandline/restart.md | 14 ++-- docs/reference/commandline/rm.md | 14 ++-- docs/reference/commandline/rmi.md | 14 ++-- docs/reference/commandline/run.md | 14 ++-- docs/reference/commandline/save.md | 14 ++-- docs/reference/commandline/search.md | 14 ++-- docs/reference/commandline/service_create.md | 14 ++-- docs/reference/commandline/service_inspect.md | 14 ++-- docs/reference/commandline/service_ls.md | 14 ++-- docs/reference/commandline/service_ps.md | 16 ++--- docs/reference/commandline/service_rm.md | 14 ++-- docs/reference/commandline/service_scale.md | 14 ++-- docs/reference/commandline/service_update.md | 14 ++-- docs/reference/commandline/stack_config.md | 16 ++--- docs/reference/commandline/stack_deploy.md | 16 ++--- docs/reference/commandline/stack_ls.md | 16 ++--- docs/reference/commandline/stack_ps.md | 16 ++--- docs/reference/commandline/stack_rm.md | 18 +++-- docs/reference/commandline/stack_services.md | 16 ++--- docs/reference/commandline/start.md | 14 ++-- docs/reference/commandline/stats.md | 14 ++-- docs/reference/commandline/stop.md | 14 ++-- docs/reference/commandline/swarm_init.md | 14 ++-- docs/reference/commandline/swarm_join.md | 14 ++-- .../reference/commandline/swarm_join_token.md | 14 ++-- docs/reference/commandline/swarm_leave.md | 14 ++-- docs/reference/commandline/swarm_update.md | 14 ++-- docs/reference/commandline/system_df.md | 14 ++-- docs/reference/commandline/system_prune.md | 14 ++-- docs/reference/commandline/tag.md | 14 ++-- docs/reference/commandline/top.md | 14 ++-- docs/reference/commandline/unpause.md | 14 ++-- docs/reference/commandline/update.md | 18 ++--- docs/reference/commandline/version.md | 14 ++-- docs/reference/commandline/volume_create.md | 16 ++--- docs/reference/commandline/volume_inspect.md | 14 ++-- docs/reference/commandline/volume_ls.md | 14 ++-- docs/reference/commandline/volume_prune.md | 14 ++-- docs/reference/commandline/volume_rm.md | 15 ++--- docs/reference/commandline/wait.md | 14 ++-- docs/reference/glossary.md | 15 ++--- docs/reference/index.md | 16 ++--- docs/reference/run.md | 17 ++--- 119 files changed, 660 insertions(+), 1161 deletions(-) diff --git a/docs/deprecated.md b/docs/deprecated.md index a591880ef0..43dfc29275 100644 --- a/docs/deprecated.md +++ b/docs/deprecated.md @@ -1,14 +1,9 @@ - +--- +aliases: ["/engine/misc/deprecated/"] +title: "Deprecated Engine Features" +description: "Deprecated Features." +keywords: ["docker, documentation, about, technology, deprecate"] +--- # Deprecated Engine Features @@ -192,7 +187,7 @@ The single-dash (`-help`) was removed, in favor of the double-dash `--help` **Removed In Release: [v1.13.0](https://github.com/docker/docker/releases/)** -The flag `--run` of the docker commit (and its short version `-run`) were deprecated in favor +The flag `--run` of the docker commit (and its short version `-run`) were deprecated in favor of the `--changes` flag that allows to pass `Dockerfile` commands. diff --git a/docs/extend/index.md b/docs/extend/index.md index 4ce1eac1c5..9ca4dd9c42 100644 --- a/docs/extend/index.md +++ b/docs/extend/index.md @@ -1,17 +1,12 @@ - +title: "Managed plugin system" +description: "How develop and use a plugin with the managed plugin system" +keywords: ["API, Usage, plugins, documentation, developer"] +advisory: "experimental" +--- # Docker Engine managed plugin system diff --git a/docs/extend/legacy_plugins.md b/docs/extend/legacy_plugins.md index aa4fa4a9b3..4e4d88a871 100644 --- a/docs/extend/legacy_plugins.md +++ b/docs/extend/legacy_plugins.md @@ -1,14 +1,9 @@ - +--- +aliases: "/engine/extend/plugins/" +title: "Use Docker Engine plugins" +description: "How to add additional functionality to Docker with plugins extensions" +keywords: ["Examples, Usage, plugins, docker, documentation, user guide"] +--- # Use Docker Engine plugins diff --git a/docs/extend/manifest.md b/docs/extend/manifest.md index d47efce8e8..e0fc3c3bec 100644 --- a/docs/extend/manifest.md +++ b/docs/extend/manifest.md @@ -1,17 +1,12 @@ - +title: "Plugin manifest" +description: "How develop and use a plugin with the managed plugin system" +keywords: ["API, Usage, plugins, documentation, developer"] +advisory: "experimental" +--- # Plugin Manifest Version 0 of Plugin V2 @@ -47,7 +42,7 @@ Manifest provides the base accessible fields for working with V0 plugin format - **`interface`** *PluginInterface* interface implemented by the plugins, struct consisting of the following fields - + - **`types`** *string array* types indicate what interface(s) the plugin currently implements. @@ -55,9 +50,9 @@ Manifest provides the base accessible fields for working with V0 plugin format currently supported: - **docker.volumedriver/1.0** - + - **`socket`** *string* - + socket is the name of the socket the engine should use to communicate with the plugins. the socket will be created in `/run/docker/plugins`. @@ -73,7 +68,7 @@ Manifest provides the base accessible fields for working with V0 plugin format - **`network`** *PluginNetwork* network of the plugin, struct consisting of the following fields - + - **`type`** *string* network type. @@ -83,11 +78,11 @@ Manifest provides the base accessible fields for working with V0 plugin format - **bridge** - **host** - **none** - + - **`capabilities`** *array* capabilities of the plugin (*Linux only*), see list [`here`](https://github.com/opencontainers/runc/blob/master/libcontainer/SPEC.md#security) - + - **`mounts`** *PluginMount array* mount of the plugin, struct consisting of the following fields, see [`MOUNTS`](https://github.com/opencontainers/runtime-spec/blob/master/config.md#mounts) @@ -95,27 +90,27 @@ Manifest provides the base accessible fields for working with V0 plugin format - **`name`** *string* name of the mount. - + - **`description`** *string* - + description of the mount. - + - **`source`** *string* source of the mount. - + - **`destination`** *string* destination of the mount. - + - **`type`** *string* mount type. - + - **`options`** *string array* options of the mount. - + - **`devices`** *PluginDevice array* device of the plugin, (*Linux only*), struct consisting of the following fields, see [`DEVICES`](https://github.com/opencontainers/runtime-spec/blob/master/config-linux.md#devices) @@ -123,11 +118,11 @@ Manifest provides the base accessible fields for working with V0 plugin format - **`name`** *string* name of the device. - + - **`description`** *string* description of the device. - + - **`path`** *string* path of the device. @@ -139,15 +134,15 @@ Manifest provides the base accessible fields for working with V0 plugin format - **`name`** *string* name of the env. - + - **`description`** *string* - + description of the env. - + - **`value`** *string* value of the env. - + - **`args`** *PluginArgs* args of the plugin, struct consisting of the following fields @@ -155,16 +150,16 @@ Manifest provides the base accessible fields for working with V0 plugin format - **`name`** *string* name of the env. - + - **`description`** *string* - + description of the env. - + - **`value`** *string array* values of the args. - - + + ## Example Manifest *Example showing the 'tiborvass/no-remove' plugin manifest.* diff --git a/docs/extend/menu.md b/docs/extend/menu.md index 4b9955038a..8403872625 100644 --- a/docs/extend/menu.md +++ b/docs/extend/menu.md @@ -1,15 +1,10 @@ - +--- +title: "Implement plugins" +description: "Develop plugins and use existing plugins for Docker Engine" +keywords: ["extend, plugins, docker, documentation, developer"] +type: "menu" +identifier: "engine_extend" +--- diff --git a/docs/extend/plugin_api.md b/docs/extend/plugin_api.md index 5801ba9151..edf05872cf 100644 --- a/docs/extend/plugin_api.md +++ b/docs/extend/plugin_api.md @@ -1,13 +1,8 @@ - +--- +title: "Plugins API" +description: "How to write Docker plugins extensions " +keywords: ["API, Usage, plugins, documentation, developer"] +--- # Docker Plugin API diff --git a/docs/extend/plugins_authorization.md b/docs/extend/plugins_authorization.md index 2c3d79e25d..77749547f5 100644 --- a/docs/extend/plugins_authorization.md +++ b/docs/extend/plugins_authorization.md @@ -1,14 +1,9 @@ - +--- +title: "Access authorization plugin" +description: "How to create authorization plugins to manage access control to your Docker daemon." +keywords: ["security, authorization, authentication, docker, documentation, plugin, extend"] +aliases: ["/engine/extend/authorization/"] +--- # Create an authorization plugin diff --git a/docs/extend/plugins_network.md b/docs/extend/plugins_network.md index 7a107e2ce3..5313be8402 100644 --- a/docs/extend/plugins_network.md +++ b/docs/extend/plugins_network.md @@ -1,13 +1,8 @@ - +--- +title: "Docker network driver plugins" +description: "Network driver plugins." +keywords: ["Examples, Usage, plugins, docker, documentation, user guide"] +--- # Engine network driver plugins diff --git a/docs/extend/plugins_volume.md b/docs/extend/plugins_volume.md index f9c93a3de1..2f53047f33 100644 --- a/docs/extend/plugins_volume.md +++ b/docs/extend/plugins_volume.md @@ -1,13 +1,8 @@ - +--- +title: "Volume plugins" +description: "How to manage data with external volume plugins" +keywords: ["Examples, Usage, volume, docker, data, volumes, plugin, api"] +--- # Write a volume plugin diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md index 3648522344..9c2c1b7407 100644 --- a/docs/reference/api/README.md +++ b/docs/reference/api/README.md @@ -1,8 +1,6 @@ - +--- +published: false +--- This directory holds the authoritative specifications of APIs defined and implemented by Docker. Currently this includes: diff --git a/docs/reference/api/docker-io_api.md b/docs/reference/api/docker-io_api.md index 5e3c684484..aebb2dc611 100644 --- a/docs/reference/api/docker-io_api.md +++ b/docs/reference/api/docker-io_api.md @@ -1,14 +1,9 @@ - +--- +published: false +title: "Docker Hub API" +description: "API Documentation for the Docker Hub API" +keywords: ["API, Docker, index, REST, documentation, Docker Hub, registry"] +--- # Docker Hub API diff --git a/docs/reference/api/docker_io_accounts_api.md b/docs/reference/api/docker_io_accounts_api.md index dfee194b19..d3c6f520aa 100644 --- a/docs/reference/api/docker_io_accounts_api.md +++ b/docs/reference/api/docker_io_accounts_api.md @@ -1,13 +1,8 @@ - +--- +title: "docker.io accounts API" +description: "API Documentation for docker.io accounts." +keywords: ["API, Docker, accounts, REST, documentation"] +--- # docker.io accounts API diff --git a/docs/reference/api/docker_remote_api.md b/docs/reference/api/docker_remote_api.md index 91008b4e17..ab7e873911 100644 --- a/docs/reference/api/docker_remote_api.md +++ b/docs/reference/api/docker_remote_api.md @@ -1,13 +1,8 @@ - +--- +title: "Remote API" +description: "API Documentation for Docker" +keywords: ["API, Docker, rcli, REST, documentation"] +--- # Docker Remote API diff --git a/docs/reference/api/docker_remote_api_v1.18.md b/docs/reference/api/docker_remote_api_v1.18.md index b3616f6b79..07bed5652c 100644 --- a/docs/reference/api/docker_remote_api_v1.18.md +++ b/docs/reference/api/docker_remote_api_v1.18.md @@ -1,13 +1,8 @@ - +--- +title: "Remote API v1.18" +description: "API Documentation for Docker" +keywords: ["API, Docker, rcli, REST, documentation"] +--- # Docker Remote API v1.18 diff --git a/docs/reference/api/docker_remote_api_v1.19.md b/docs/reference/api/docker_remote_api_v1.19.md index 3b4db54fd7..8370727eb6 100644 --- a/docs/reference/api/docker_remote_api_v1.19.md +++ b/docs/reference/api/docker_remote_api_v1.19.md @@ -1,13 +1,8 @@ - +--- +title: "Remote API v1.19" +description: "API Documentation for Docker" +keywords: ["API, Docker, rcli, REST, documentation"] +--- # Docker Remote API v1.19 diff --git a/docs/reference/api/docker_remote_api_v1.20.md b/docs/reference/api/docker_remote_api_v1.20.md index 698fa7a6a6..0468ba4c2b 100644 --- a/docs/reference/api/docker_remote_api_v1.20.md +++ b/docs/reference/api/docker_remote_api_v1.20.md @@ -1,13 +1,8 @@ - +--- +title: "Remote API v1.20" +description: "API Documentation for Docker" +keywords: ["API, Docker, rcli, REST, documentation"] +--- # Docker Remote API v1.20 diff --git a/docs/reference/api/docker_remote_api_v1.21.md b/docs/reference/api/docker_remote_api_v1.21.md index e89605c807..d6c5aecb68 100644 --- a/docs/reference/api/docker_remote_api_v1.21.md +++ b/docs/reference/api/docker_remote_api_v1.21.md @@ -1,13 +1,8 @@ - +--- +title: "Remote API v1.21" +description: "API Documentation for Docker" +keywords: ["API, Docker, rcli, REST, documentation"] +--- # Docker Remote API v1.21 diff --git a/docs/reference/api/docker_remote_api_v1.22.md b/docs/reference/api/docker_remote_api_v1.22.md index 1f6d4c192e..649d593e84 100644 --- a/docs/reference/api/docker_remote_api_v1.22.md +++ b/docs/reference/api/docker_remote_api_v1.22.md @@ -1,13 +1,8 @@ - +--- +title: "Remote API v1.22" +description: "API Documentation for Docker" +keywords: ["API, Docker, rcli, REST, documentation"] +--- # Docker Remote API v1.22 diff --git a/docs/reference/api/docker_remote_api_v1.23.md b/docs/reference/api/docker_remote_api_v1.23.md index d188f79d36..73e30a8030 100644 --- a/docs/reference/api/docker_remote_api_v1.23.md +++ b/docs/reference/api/docker_remote_api_v1.23.md @@ -1,13 +1,8 @@ - +--- +title: "Remote API v1.23" +description: "API Documentation for Docker" +keywords: ["API, Docker, rcli, REST, documentation"] +--- # Docker Remote API v1.23 @@ -2688,7 +2683,7 @@ See the [image tarball format](#image-tarball-format) for more details. **Example response**: -If the "quiet" query parameter is set to `true` / `1` (`?quiet=1`), progress +If the "quiet" query parameter is set to `true` / `1` (`?quiet=1`), progress details are suppressed, and only a confirmation message is returned once the action completes. diff --git a/docs/reference/api/docker_remote_api_v1.24.md b/docs/reference/api/docker_remote_api_v1.24.md index efd0e939cf..daa387cbeb 100644 --- a/docs/reference/api/docker_remote_api_v1.24.md +++ b/docs/reference/api/docker_remote_api_v1.24.md @@ -1,13 +1,8 @@ - +--- +title: "Remote API v1.24" +description: "API Documentation for Docker" +keywords: ["API, Docker, rcli, REST, documentation"] +--- # Docker Remote API v1.24 @@ -2702,7 +2697,7 @@ See the [image tarball format](#image-tarball-format) for more details. **Example response**: -If the "quiet" query parameter is set to `true` / `1` (`?quiet=1`), progress +If the "quiet" query parameter is set to `true` / `1` (`?quiet=1`), progress details are suppressed, and only a confirmation message is returned once the action completes. diff --git a/docs/reference/api/docker_remote_api_v1.25.md b/docs/reference/api/docker_remote_api_v1.25.md index f7a5685841..56f4719872 100644 --- a/docs/reference/api/docker_remote_api_v1.25.md +++ b/docs/reference/api/docker_remote_api_v1.25.md @@ -1,13 +1,8 @@ - +--- +title: "Remote API v1.25" +description: "API Documentation for Docker" +keywords: ["API, Docker, rcli, REST, documentation"] +--- # Docker Remote API v1.25 @@ -3095,7 +3090,7 @@ See the [image tarball format](#image-tarball-format) for more details. **Example response**: -If the "quiet" query parameter is set to `true` / `1` (`?quiet=1`), progress +If the "quiet" query parameter is set to `true` / `1` (`?quiet=1`), progress details are suppressed, and only a confirmation message is returned once the action completes. diff --git a/docs/reference/api/hub_registry_spec.md b/docs/reference/api/hub_registry_spec.md index 87c4c88482..03fe0a7398 100644 --- a/docs/reference/api/hub_registry_spec.md +++ b/docs/reference/api/hub_registry_spec.md @@ -1,13 +1,9 @@ - +--- +published: false +title: "The Docker Hub and the Registry v1" +description: "Documentation for docker Registry and Registry API" +keywords: ["docker, registry, api, hub"] +--- # The Docker Hub and the Registry v1 diff --git a/docs/reference/api/index.md b/docs/reference/api/index.md index 05f3d126f2..2d20f8b8d9 100644 --- a/docs/reference/api/index.md +++ b/docs/reference/api/index.md @@ -1,13 +1,9 @@ - +--- +title: "API Reference" +description: "Reference" +keywords: ["Engine"] +identifier: "engine_remoteapi" +--- # API Reference diff --git a/docs/reference/api/remote_api_client_libraries.md b/docs/reference/api/remote_api_client_libraries.md index 4b7f4327e6..a9bd205fb8 100644 --- a/docs/reference/api/remote_api_client_libraries.md +++ b/docs/reference/api/remote_api_client_libraries.md @@ -1,13 +1,8 @@ - +--- +title: "Remote API client libraries" +description: "Various client libraries available to use with the Docker remote API" +keywords: ["API, Docker, index, registry, REST, documentation, clients, C#, Erlang, Go, Groovy, Java, JavaScript, Perl, PHP, Python, Ruby, Rust, Scala"] +--- # Docker Remote API client libraries diff --git a/docs/reference/builder.md b/docs/reference/builder.md index bef2b85535..5b22fa1412 100644 --- a/docs/reference/builder.md +++ b/docs/reference/builder.md @@ -1,13 +1,8 @@ - +--- +title: "Dockerfile reference" +description: "Dockerfiles use a simple DSL which allows you to automate the steps you would normally manually take to create an image." +keywords: ["builder, docker, Dockerfile, automation, image creation"] +--- # Dockerfile reference @@ -698,7 +693,7 @@ To view an image's labels, use the `docker inspect` command. MAINTAINER -The `MAINTAINER` instruction sets the *Author* field of the generated images. +The `MAINTAINER` instruction sets the *Author* field of the generated images. The `LABEL` instruction is a much more flexible version of this and you should use it instead, as it enables setting any metadata you require, and can be viewed easily, for example with `docker inspect`. To set a label corresponding to the diff --git a/docs/reference/commandline/attach.md b/docs/reference/commandline/attach.md index d0b519840b..3a9f5316c0 100644 --- a/docs/reference/commandline/attach.md +++ b/docs/reference/commandline/attach.md @@ -1,12 +1,8 @@ - +--- +title: "attach" +description: "The attach command description and usage" +keywords: ["attach, running, container"] +--- # attach diff --git a/docs/reference/commandline/build.md b/docs/reference/commandline/build.md index 65f54cc81f..667ea97977 100644 --- a/docs/reference/commandline/build.md +++ b/docs/reference/commandline/build.md @@ -1,12 +1,8 @@ - +--- +title: "build" +description: "The build command description and usage" +keywords: ["build, docker, image"] +--- # build diff --git a/docs/reference/commandline/cli.md b/docs/reference/commandline/cli.md index f79bf45406..9c13f81113 100644 --- a/docs/reference/commandline/cli.md +++ b/docs/reference/commandline/cli.md @@ -1,13 +1,8 @@ - +--- +title: "Use the Docker command line" +description: "Docker's CLI command description and usage" +keywords: ["Docker, Docker documentation, CLI, command line"] +--- # Use the Docker command line @@ -122,7 +117,7 @@ directives, see the Once attached to a container, users detach from it and leave it running using the using `CTRL-p CTRL-q` key sequence. This detach key sequence is customizable using the `detachKeys` property. Specify a `` value for the -property. The format of the `` is a comma-separated list of either +property. The format of the `` is a comma-separated list of either a letter [a-Z], or the `ctrl-` combined with any of the following: * `a-z` (a single lowercase alpha character ) diff --git a/docs/reference/commandline/commit.md b/docs/reference/commandline/commit.md index acfb7c95be..22682b14c2 100644 --- a/docs/reference/commandline/commit.md +++ b/docs/reference/commandline/commit.md @@ -1,12 +1,8 @@ - +--- +title: "commit" +description: "The commit command description and usage" +keywords: ["commit, file, changes"] +--- # commit diff --git a/docs/reference/commandline/container_prune.md b/docs/reference/commandline/container_prune.md index 2301353afa..2f00f17165 100644 --- a/docs/reference/commandline/container_prune.md +++ b/docs/reference/commandline/container_prune.md @@ -1,12 +1,8 @@ - +--- +title: "container prune" +description: "Remove all stopped containers" +keywords: [container, prune, delete, remove] +--- # container prune diff --git a/docs/reference/commandline/cp.md b/docs/reference/commandline/cp.md index b3a0b78916..fc661d73c7 100644 --- a/docs/reference/commandline/cp.md +++ b/docs/reference/commandline/cp.md @@ -1,12 +1,8 @@ - +--- +title: "cp" +description: "The cp command description and usage" +keywords: ["copy, container, files, folders"] +--- # cp diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/create.md index 9e3dfdead5..51a09a9c40 100644 --- a/docs/reference/commandline/create.md +++ b/docs/reference/commandline/create.md @@ -1,12 +1,8 @@ - +--- +title: "create" +description: "The create command description and usage" +keywords: ["docker, create, container"] +--- # create diff --git a/docs/reference/commandline/deploy.md b/docs/reference/commandline/deploy.md index 908131e4bb..bc17e7bcab 100644 --- a/docs/reference/commandline/deploy.md +++ b/docs/reference/commandline/deploy.md @@ -1,13 +1,9 @@ - +--- +title: "deploy" +description: "The deploy command description and usage" +keywords: ["stack, deploy"] +advisory: "experimental" +--- # stack deploy (experimental) diff --git a/docs/reference/commandline/diff.md b/docs/reference/commandline/diff.md index 8c01b8cdf2..011e36fb71 100644 --- a/docs/reference/commandline/diff.md +++ b/docs/reference/commandline/diff.md @@ -1,12 +1,8 @@ - +--- +title: "diff" +description: "The diff command description and usage" +keywords: ["list, changed, files, container"] +--- # diff diff --git a/docs/reference/commandline/dockerd.md b/docs/reference/commandline/dockerd.md index 0233476ce8..6e020ff6ad 100644 --- a/docs/reference/commandline/dockerd.md +++ b/docs/reference/commandline/dockerd.md @@ -1,14 +1,9 @@ - +--- +title: "dockerd" +aliases: ["/engine/reference/commandline/daemon/"] +description: "The daemon command description and usage" +keywords: ["container, daemon, runtime"] +--- # daemon diff --git a/docs/reference/commandline/events.md b/docs/reference/commandline/events.md index 789bb57ffb..c9821814de 100644 --- a/docs/reference/commandline/events.md +++ b/docs/reference/commandline/events.md @@ -1,12 +1,8 @@ - +--- +title: "events" +description: "The events command description and usage" +keywords: ["events, container, report"] +--- # events diff --git a/docs/reference/commandline/exec.md b/docs/reference/commandline/exec.md index 3f422de662..9be6cbadd8 100644 --- a/docs/reference/commandline/exec.md +++ b/docs/reference/commandline/exec.md @@ -1,12 +1,8 @@ - +--- +title: "exec" +description: "The exec command description and usage" +keywords: ["command, container, run, execute"] +--- # exec diff --git a/docs/reference/commandline/export.md b/docs/reference/commandline/export.md index 54e6e01a6e..78c1a84ceb 100644 --- a/docs/reference/commandline/export.md +++ b/docs/reference/commandline/export.md @@ -1,12 +1,8 @@ - +--- +title: "export" +description: "The export command description and usage" +keywords: ["export, file, system, container"] +--- # export diff --git a/docs/reference/commandline/history.md b/docs/reference/commandline/history.md index 895fd55ea9..36668bdc4c 100644 --- a/docs/reference/commandline/history.md +++ b/docs/reference/commandline/history.md @@ -1,12 +1,8 @@ - +--- +title: "history" +description: "The history command description and usage" +keywords: ["docker, image, history"] +--- # history diff --git a/docs/reference/commandline/image_prune.md b/docs/reference/commandline/image_prune.md index 85bd8ce1a6..d4c269e33f 100644 --- a/docs/reference/commandline/image_prune.md +++ b/docs/reference/commandline/image_prune.md @@ -1,12 +1,8 @@ - +--- +title: "image prune" +description: "Remove all stopped images" +keywords: [image, prune, delete, remove] +--- # image prune diff --git a/docs/reference/commandline/images.md b/docs/reference/commandline/images.md index af21a8197d..414b6f4666 100644 --- a/docs/reference/commandline/images.md +++ b/docs/reference/commandline/images.md @@ -1,12 +1,8 @@ - +--- +title: "images" +description: "The images command description and usage" +keywords: ["list, docker, images"] +--- # images diff --git a/docs/reference/commandline/import.md b/docs/reference/commandline/import.md index 2d2c88b4e8..1319dce849 100644 --- a/docs/reference/commandline/import.md +++ b/docs/reference/commandline/import.md @@ -1,12 +1,8 @@ - +--- +title: "import" +description: "The import command description and usage" +keywords: ["import, file, system, container"] +--- # import diff --git a/docs/reference/commandline/index.md b/docs/reference/commandline/index.md index ed8d2996a8..86be46b543 100644 --- a/docs/reference/commandline/index.md +++ b/docs/reference/commandline/index.md @@ -1,14 +1,9 @@ - +--- +title: "Docker commands" +description: "Docker's CLI command description and usage" +keywords: ["Docker, Docker documentation, CLI, command line"] +identifier: "smn_cli_guide" +--- diff --git a/docs/reference/commandline/info.md b/docs/reference/commandline/info.md index 3bf813c057..a880fb7556 100644 --- a/docs/reference/commandline/info.md +++ b/docs/reference/commandline/info.md @@ -1,12 +1,8 @@ - +--- +title: "info" +description: "The info command description and usage" +keywords: ["display, docker, information"] +--- # info diff --git a/docs/reference/commandline/inspect.md b/docs/reference/commandline/inspect.md index d5c073f26c..697254a07a 100644 --- a/docs/reference/commandline/inspect.md +++ b/docs/reference/commandline/inspect.md @@ -1,12 +1,8 @@ - +--- +title: "inspect" +description: "The inspect command description and usage" +keywords: ["inspect, container, json"] +--- # inspect diff --git a/docs/reference/commandline/kill.md b/docs/reference/commandline/kill.md index 55b11efad2..65c5ec1107 100644 --- a/docs/reference/commandline/kill.md +++ b/docs/reference/commandline/kill.md @@ -1,12 +1,8 @@ - +--- +title: "kill" +description: "The kill command description and usage" +keywords: ["container, kill, signal"] +--- # kill diff --git a/docs/reference/commandline/load.md b/docs/reference/commandline/load.md index be8ed05cf2..dd15c85eab 100644 --- a/docs/reference/commandline/load.md +++ b/docs/reference/commandline/load.md @@ -1,12 +1,8 @@ - +--- +title: "load" +description: "The load command description and usage" +keywords: ["stdin, tarred, repository"] +--- # load diff --git a/docs/reference/commandline/login.md b/docs/reference/commandline/login.md index 3308ae5d6b..b7a0c81a48 100644 --- a/docs/reference/commandline/login.md +++ b/docs/reference/commandline/login.md @@ -1,12 +1,8 @@ - +--- +title: "login" +description: "The login command description and usage" +keywords: ["registry, login, image"] +--- # login diff --git a/docs/reference/commandline/logout.md b/docs/reference/commandline/logout.md index a073b34f88..989be9b456 100644 --- a/docs/reference/commandline/logout.md +++ b/docs/reference/commandline/logout.md @@ -1,12 +1,8 @@ - +--- +title: "logout" +description: "The logout command description and usage" +keywords: ["logout, docker, registry"] +--- # logout diff --git a/docs/reference/commandline/logs.md b/docs/reference/commandline/logs.md index 437e709631..55823a3712 100644 --- a/docs/reference/commandline/logs.md +++ b/docs/reference/commandline/logs.md @@ -1,12 +1,8 @@ - +--- +title: "logs" +description: "The logs command description and usage" +keywords: ["logs, retrieve, docker"] +--- # logs diff --git a/docs/reference/commandline/menu.md b/docs/reference/commandline/menu.md index 9ade86d26a..41677e7ea7 100644 --- a/docs/reference/commandline/menu.md +++ b/docs/reference/commandline/menu.md @@ -1,14 +1,9 @@ - +--- +title: "Command line reference" +description: "Docker's CLI command description and usage" +keywords: ["Docker, Docker documentation, CLI, command line"] +identifier: "smn_cli" +--- diff --git a/docs/reference/commandline/network_connect.md b/docs/reference/commandline/network_connect.md index 5a9ed866ef..d4a2c90077 100644 --- a/docs/reference/commandline/network_connect.md +++ b/docs/reference/commandline/network_connect.md @@ -1,12 +1,8 @@ - +--- +title: "network connect" +description: "The network connect command description and usage" +keywords: ["network, connect, user-defined"] +--- # network connect diff --git a/docs/reference/commandline/network_create.md b/docs/reference/commandline/network_create.md index 8ffed10972..426de03085 100644 --- a/docs/reference/commandline/network_create.md +++ b/docs/reference/commandline/network_create.md @@ -1,12 +1,8 @@ - +--- +title: "network create" +description: "The network create command description and usage" +keywords: ["network, create"] +--- # network create diff --git a/docs/reference/commandline/network_disconnect.md b/docs/reference/commandline/network_disconnect.md index 2d43ccb1e9..93afd19def 100644 --- a/docs/reference/commandline/network_disconnect.md +++ b/docs/reference/commandline/network_disconnect.md @@ -1,12 +1,8 @@ - +--- +title: "network disconnect" +description: "The network disconnect command description and usage" +keywords: ["network, disconnect, user-defined"] +--- # network disconnect diff --git a/docs/reference/commandline/network_inspect.md b/docs/reference/commandline/network_inspect.md index 9aebc66b5a..1e0b3e53dd 100644 --- a/docs/reference/commandline/network_inspect.md +++ b/docs/reference/commandline/network_inspect.md @@ -1,12 +1,8 @@ - +--- +title: "network inspect" +description: "The network inspect command description and usage" +keywords: ["network, inspect, user-defined"] +--- # network inspect diff --git a/docs/reference/commandline/network_ls.md b/docs/reference/commandline/network_ls.md index 18a65da06a..a52ebaea36 100644 --- a/docs/reference/commandline/network_ls.md +++ b/docs/reference/commandline/network_ls.md @@ -1,12 +1,8 @@ - +--- +title: "network ls" +description: "The network ls command description and usage" +keywords: ["network, list, user-defined"] +--- # docker network ls diff --git a/docs/reference/commandline/network_rm.md b/docs/reference/commandline/network_rm.md index d57254636a..b6586e72aa 100644 --- a/docs/reference/commandline/network_rm.md +++ b/docs/reference/commandline/network_rm.md @@ -1,12 +1,8 @@ - +--- +title: "network rm" +description: "the network rm command description and usage" +keywords: ["network, rm, user-defined"] +--- # network rm diff --git a/docs/reference/commandline/node_demote.md b/docs/reference/commandline/node_demote.md index 2cec22ac3b..e84d45c891 100644 --- a/docs/reference/commandline/node_demote.md +++ b/docs/reference/commandline/node_demote.md @@ -1,12 +1,8 @@ - +--- +title: "node demote" +description: "The node demote command description and usage" +keywords: ["node, demote"] +--- # node demote diff --git a/docs/reference/commandline/node_inspect.md b/docs/reference/commandline/node_inspect.md index 2f3370adbc..9edc081f3b 100644 --- a/docs/reference/commandline/node_inspect.md +++ b/docs/reference/commandline/node_inspect.md @@ -1,12 +1,8 @@ - +--- +title: "node inspect" +description: "The node inspect command description and usage" +keywords: ["node, inspect"] +--- # node inspect diff --git a/docs/reference/commandline/node_ls.md b/docs/reference/commandline/node_ls.md index e918b7d11a..19d9ff377b 100644 --- a/docs/reference/commandline/node_ls.md +++ b/docs/reference/commandline/node_ls.md @@ -1,12 +1,8 @@ - +--- +title: "node ls" +description: "The node ls command description and usage" +keywords: ["node, list"] +--- # node ls diff --git a/docs/reference/commandline/node_promote.md b/docs/reference/commandline/node_promote.md index 7f5830d92a..5beada1cc7 100644 --- a/docs/reference/commandline/node_promote.md +++ b/docs/reference/commandline/node_promote.md @@ -1,12 +1,8 @@ - +--- +title: "node promote" +description: "The node promote command description and usage" +keywords: ["node, promote"] +--- # node promote diff --git a/docs/reference/commandline/node_ps.md b/docs/reference/commandline/node_ps.md index 538132408a..7a1272bb8b 100644 --- a/docs/reference/commandline/node_ps.md +++ b/docs/reference/commandline/node_ps.md @@ -1,13 +1,9 @@ - +--- +title: "node ps" +description: "The node ps command description and usage" +keywords: ["node, tasks", "ps"] +aliases: ["/engine/reference/commandline/node_tasks/"] +--- # node ps diff --git a/docs/reference/commandline/node_rm.md b/docs/reference/commandline/node_rm.md index ee6dcf7212..34643c395b 100644 --- a/docs/reference/commandline/node_rm.md +++ b/docs/reference/commandline/node_rm.md @@ -1,12 +1,8 @@ - +--- +title: "node rm" +description: "The node rm command description and usage" +keywords: ["node, remove"] +--- # node rm diff --git a/docs/reference/commandline/node_update.md b/docs/reference/commandline/node_update.md index 5205a7d96a..66fe091772 100644 --- a/docs/reference/commandline/node_update.md +++ b/docs/reference/commandline/node_update.md @@ -1,12 +1,8 @@ - +--- +title: "node update" +description: "The node update command description and usage" +keywords: ["resources, update, dynamically"] +--- ## update diff --git a/docs/reference/commandline/pause.md b/docs/reference/commandline/pause.md index 6e85ebbea0..14eca8dc3d 100644 --- a/docs/reference/commandline/pause.md +++ b/docs/reference/commandline/pause.md @@ -1,12 +1,8 @@ - +--- +title: "pause" +description: "The pause command description and usage" +keywords: ["cgroups, container, suspend, SIGSTOP"] +--- # pause diff --git a/docs/reference/commandline/plugin_disable.md b/docs/reference/commandline/plugin_disable.md index eae31975e1..a228cfd38c 100644 --- a/docs/reference/commandline/plugin_disable.md +++ b/docs/reference/commandline/plugin_disable.md @@ -1,13 +1,9 @@ - +--- +title: "plugin disable" +description: "the plugin disable command description and usage" +keywords: ["plugin, disable"] +advisory: "experimental" +--- # plugin disable (experimental) diff --git a/docs/reference/commandline/plugin_enable.md b/docs/reference/commandline/plugin_enable.md index 44ef3c2fa3..e78a6a798c 100644 --- a/docs/reference/commandline/plugin_enable.md +++ b/docs/reference/commandline/plugin_enable.md @@ -1,13 +1,9 @@ - +--- +title: "plugin enable" +description: "the plugin enable command description and usage" +keywords: ["plugin, enable"] +advisory: "experimental" +--- # plugin enable (experimental) diff --git a/docs/reference/commandline/plugin_inspect.md b/docs/reference/commandline/plugin_inspect.md index e8c219d266..01f5877e8c 100755 --- a/docs/reference/commandline/plugin_inspect.md +++ b/docs/reference/commandline/plugin_inspect.md @@ -1,13 +1,9 @@ - +--- +title: "plugin inspect" +description: "The plugin inspect command description and usage" +keywords: ["plugin, inspect"] +advisory: "experimental" +--- # plugin inspect (experimental) diff --git a/docs/reference/commandline/plugin_install.md b/docs/reference/commandline/plugin_install.md index f3b26ab0c8..3f3e4b74af 100644 --- a/docs/reference/commandline/plugin_install.md +++ b/docs/reference/commandline/plugin_install.md @@ -1,13 +1,9 @@ - +--- +title: "plugin install" +description: "the plugin install command description and usage" +keywords: ["plugin, install"] +advisory: "experimental" +--- # plugin install (experimental) diff --git a/docs/reference/commandline/plugin_ls.md b/docs/reference/commandline/plugin_ls.md index c73fb72dd2..8f618171f1 100644 --- a/docs/reference/commandline/plugin_ls.md +++ b/docs/reference/commandline/plugin_ls.md @@ -1,13 +1,9 @@ - +--- +title: "plugin ls" +description: "The plugin ls command description and usage" +keywords: ["plugin, list"] +advisory: "experimental" +--- # plugin ls (experimental) diff --git a/docs/reference/commandline/plugin_rm.md b/docs/reference/commandline/plugin_rm.md index 6b6a2239b6..41b71c760b 100644 --- a/docs/reference/commandline/plugin_rm.md +++ b/docs/reference/commandline/plugin_rm.md @@ -1,13 +1,9 @@ - +--- +title: "plugin rm" +description: "the plugin rm command description and usage" +keywords: ["plugin, rm"] +advisory: "experimental" +--- # plugin rm (experimental) diff --git a/docs/reference/commandline/port.md b/docs/reference/commandline/port.md index e8da943c36..968ab545aa 100644 --- a/docs/reference/commandline/port.md +++ b/docs/reference/commandline/port.md @@ -1,12 +1,8 @@ - +--- +title: "port" +description: "The port command description and usage" +keywords: ["port, mapping, container"] +--- # port diff --git a/docs/reference/commandline/ps.md b/docs/reference/commandline/ps.md index 541979e819..2e34ed59f2 100644 --- a/docs/reference/commandline/ps.md +++ b/docs/reference/commandline/ps.md @@ -1,12 +1,8 @@ - +--- +title: "ps" +description: "The ps command description and usage" +keywords: ["container, running, list"] +--- # ps diff --git a/docs/reference/commandline/pull.md b/docs/reference/commandline/pull.md index f10c134863..ec351153ca 100644 --- a/docs/reference/commandline/pull.md +++ b/docs/reference/commandline/pull.md @@ -1,12 +1,8 @@ - +--- +title: "pull" +description: "The pull command description and usage" +keywords: ["pull, image, hub, docker"] +--- # pull diff --git a/docs/reference/commandline/push.md b/docs/reference/commandline/push.md index 9b70fd3516..f6cb0b0f73 100644 --- a/docs/reference/commandline/push.md +++ b/docs/reference/commandline/push.md @@ -1,12 +1,8 @@ - +--- +title: "push" +description: "The push command description and usage" +keywords: ["share, push, image"] +--- # push diff --git a/docs/reference/commandline/rename.md b/docs/reference/commandline/rename.md index f5a4fe23ec..66c8b2c52a 100644 --- a/docs/reference/commandline/rename.md +++ b/docs/reference/commandline/rename.md @@ -1,12 +1,8 @@ - +--- +title: "rename" +description: "The rename command description and usage" +keywords: ["rename, docker, container"] +--- # rename diff --git a/docs/reference/commandline/restart.md b/docs/reference/commandline/restart.md index 9e40a4f6c4..5c179b764d 100644 --- a/docs/reference/commandline/restart.md +++ b/docs/reference/commandline/restart.md @@ -1,12 +1,8 @@ - +--- +title: "restart" +description: "The restart command description and usage" +keywords: ["restart, container, Docker"] +--- # restart diff --git a/docs/reference/commandline/rm.md b/docs/reference/commandline/rm.md index 319ef4dbbc..ed8f354405 100644 --- a/docs/reference/commandline/rm.md +++ b/docs/reference/commandline/rm.md @@ -1,12 +1,8 @@ - +--- +title: "rm" +description: "The rm command description and usage" +keywords: ["remove, Docker, container"] +--- # rm diff --git a/docs/reference/commandline/rmi.md b/docs/reference/commandline/rmi.md index 328d9fe140..7c1faec77d 100644 --- a/docs/reference/commandline/rmi.md +++ b/docs/reference/commandline/rmi.md @@ -1,12 +1,8 @@ - +--- +title: "rmi" +description: "The rmi command description and usage" +keywords: ["remove, image, Docker"] +--- # rmi diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md index b169f9c476..386f466f6a 100644 --- a/docs/reference/commandline/run.md +++ b/docs/reference/commandline/run.md @@ -1,12 +1,8 @@ - +--- +title: "run" +description: "The run command description and usage" +keywords: ["run, command, container"] +--- # run diff --git a/docs/reference/commandline/save.md b/docs/reference/commandline/save.md index f7d1fdedcb..2a4ce8d551 100644 --- a/docs/reference/commandline/save.md +++ b/docs/reference/commandline/save.md @@ -1,12 +1,8 @@ - +--- +title: "save" +description: "The save command description and usage" +keywords: ["tarred, repository, backup"] +--- # save diff --git a/docs/reference/commandline/search.md b/docs/reference/commandline/search.md index 988db8bf1f..0efa6a5865 100644 --- a/docs/reference/commandline/search.md +++ b/docs/reference/commandline/search.md @@ -1,12 +1,8 @@ - +--- +title: "search" +description: "The search command description and usage" +keywords: ["search, hub, images"] +--- # search diff --git a/docs/reference/commandline/service_create.md b/docs/reference/commandline/service_create.md index 059996dadf..f4d0815070 100644 --- a/docs/reference/commandline/service_create.md +++ b/docs/reference/commandline/service_create.md @@ -1,12 +1,8 @@ - +--- +title: "service create" +description: "The service create command description and usage" +keywords: ["service, create"] +--- # service create diff --git a/docs/reference/commandline/service_inspect.md b/docs/reference/commandline/service_inspect.md index e24927f433..fc167d77a8 100644 --- a/docs/reference/commandline/service_inspect.md +++ b/docs/reference/commandline/service_inspect.md @@ -1,12 +1,8 @@ - +--- +title: "service inspect" +description: "The service inspect command description and usage" +keywords: ["service, inspect"] +--- # service inspect diff --git a/docs/reference/commandline/service_ls.md b/docs/reference/commandline/service_ls.md index 68c3ade6ce..5a2974aa41 100644 --- a/docs/reference/commandline/service_ls.md +++ b/docs/reference/commandline/service_ls.md @@ -1,12 +1,8 @@ - +--- +title: "service ls" +description: "The service ls command description and usage" +keywords: ["service, ls"] +--- # service ls diff --git a/docs/reference/commandline/service_ps.md b/docs/reference/commandline/service_ps.md index d6f9de5f27..4afdd455f4 100644 --- a/docs/reference/commandline/service_ps.md +++ b/docs/reference/commandline/service_ps.md @@ -1,13 +1,9 @@ - +--- +title: "service ps" +description: "The service ps command description and usage" +keywords: ["service, tasks", "ps"] +aliases: ["/engine/reference/commandline/service_tasks/"] +--- # service ps diff --git a/docs/reference/commandline/service_rm.md b/docs/reference/commandline/service_rm.md index edd9b417ed..1230ffb841 100644 --- a/docs/reference/commandline/service_rm.md +++ b/docs/reference/commandline/service_rm.md @@ -1,12 +1,8 @@ - +--- +title: "service rm" +description: "The service rm command description and usage" +keywords: ["service, rm"] +--- # service rm diff --git a/docs/reference/commandline/service_scale.md b/docs/reference/commandline/service_scale.md index f4356945e5..a21f5c4779 100644 --- a/docs/reference/commandline/service_scale.md +++ b/docs/reference/commandline/service_scale.md @@ -1,12 +1,8 @@ - +--- +title: "service scale" +description: "The service scale command description and usage" +keywords: ["service, scale"] +--- # service scale diff --git a/docs/reference/commandline/service_update.md b/docs/reference/commandline/service_update.md index dd65bb288f..f1698c3e01 100644 --- a/docs/reference/commandline/service_update.md +++ b/docs/reference/commandline/service_update.md @@ -1,12 +1,8 @@ - +--- +title: "service update" +description: "The service update command description and usage" +keywords: ["service, update"] +--- # service update diff --git a/docs/reference/commandline/stack_config.md b/docs/reference/commandline/stack_config.md index a7b8f6f5b8..470f63b621 100644 --- a/docs/reference/commandline/stack_config.md +++ b/docs/reference/commandline/stack_config.md @@ -1,13 +1,9 @@ - +--- +title: "stack config" +description: "The stack config command description and usage" +keywords: ["stack, config"] +advisory: "experimental" +--- # stack config (experimental) diff --git a/docs/reference/commandline/stack_deploy.md b/docs/reference/commandline/stack_deploy.md index 7f3c341ae3..5069c22032 100644 --- a/docs/reference/commandline/stack_deploy.md +++ b/docs/reference/commandline/stack_deploy.md @@ -1,13 +1,9 @@ - +--- +title: "stack deploy" +description: "The stack deploy command description and usage" +keywords: ["stack, deploy, up"] +advisory: "experimental" +--- # stack deploy (experimental) diff --git a/docs/reference/commandline/stack_ls.md b/docs/reference/commandline/stack_ls.md index acd570214c..b91fe430d9 100644 --- a/docs/reference/commandline/stack_ls.md +++ b/docs/reference/commandline/stack_ls.md @@ -1,13 +1,9 @@ - +--- +title: "stack ls" +description: "The stack ls command description and usage" +keywords: ["stack, ls"] +advisory: "experimental" +--- # stack ls (experimental) diff --git a/docs/reference/commandline/stack_ps.md b/docs/reference/commandline/stack_ps.md index bc71b2e4d9..fec0b07399 100644 --- a/docs/reference/commandline/stack_ps.md +++ b/docs/reference/commandline/stack_ps.md @@ -1,13 +1,9 @@ - +--- +title: "stack ps" +description: "The stack ps command description and usage" +keywords: ["stack, ps"] +advisory: "experimental" +--- # stack ps (experimental) diff --git a/docs/reference/commandline/stack_rm.md b/docs/reference/commandline/stack_rm.md index 8aae98c162..7e7a914311 100644 --- a/docs/reference/commandline/stack_rm.md +++ b/docs/reference/commandline/stack_rm.md @@ -1,13 +1,11 @@ - +--- +title: "stack rm" +description: "The stack rm command description and usage" +keywords: ["stack, rm, remove, down"] +advisory: "experimental" + + +--- # stack rm (experimental) diff --git a/docs/reference/commandline/stack_services.md b/docs/reference/commandline/stack_services.md index ed44d6b1d4..b7f4002416 100644 --- a/docs/reference/commandline/stack_services.md +++ b/docs/reference/commandline/stack_services.md @@ -1,13 +1,9 @@ - +--- +title: "stack services" +description: "The stack services command description and usage" +keywords: ["stack, services"] +advisory: "experimental" +--- # stack services (experimental) diff --git a/docs/reference/commandline/start.md b/docs/reference/commandline/start.md index 72ff7e1002..46b493c2b1 100644 --- a/docs/reference/commandline/start.md +++ b/docs/reference/commandline/start.md @@ -1,12 +1,8 @@ - +--- +title: "start" +description: "The start command description and usage" +keywords: ["Start, container, stopped"] +--- # start diff --git a/docs/reference/commandline/stats.md b/docs/reference/commandline/stats.md index d6d6ed0e1f..4ee79e292a 100644 --- a/docs/reference/commandline/stats.md +++ b/docs/reference/commandline/stats.md @@ -1,12 +1,8 @@ - +--- +title: "stats" +description: "The stats command description and usage" +keywords: ["container, resource, statistics"] +--- # stats diff --git a/docs/reference/commandline/stop.md b/docs/reference/commandline/stop.md index 662255846f..e888562799 100644 --- a/docs/reference/commandline/stop.md +++ b/docs/reference/commandline/stop.md @@ -1,12 +1,8 @@ - +--- +title: "stop" +description: "The stop command description and usage" +keywords: ["stop, SIGKILL, SIGTERM"] +--- # stop diff --git a/docs/reference/commandline/swarm_init.md b/docs/reference/commandline/swarm_init.md index 6df0cdb1d0..7d33cdab3a 100644 --- a/docs/reference/commandline/swarm_init.md +++ b/docs/reference/commandline/swarm_init.md @@ -1,12 +1,8 @@ - +--- +title: "swarm init" +description: "The swarm init command description and usage" +keywords: ["swarm, init"] +--- # swarm init diff --git a/docs/reference/commandline/swarm_join.md b/docs/reference/commandline/swarm_join.md index c0a7d91cc3..9afdec1225 100644 --- a/docs/reference/commandline/swarm_join.md +++ b/docs/reference/commandline/swarm_join.md @@ -1,12 +1,8 @@ - +--- +title: "swarm join" +description: "The swarm join command description and usage" +keywords: ["swarm, join"] +--- # swarm join diff --git a/docs/reference/commandline/swarm_join_token.md b/docs/reference/commandline/swarm_join_token.md index f808d84244..468d841a6a 100644 --- a/docs/reference/commandline/swarm_join_token.md +++ b/docs/reference/commandline/swarm_join_token.md @@ -1,12 +1,8 @@ - +--- +title: "swarm join-token" +description: "The swarm join-token command description and usage" +keywords: ["swarm, join-token"] +--- # swarm join-token diff --git a/docs/reference/commandline/swarm_leave.md b/docs/reference/commandline/swarm_leave.md index 112813466b..6520480025 100644 --- a/docs/reference/commandline/swarm_leave.md +++ b/docs/reference/commandline/swarm_leave.md @@ -1,12 +1,8 @@ - +--- +title: "swarm leave" +description: "The swarm leave command description and usage" +keywords: ["swarm, leave"] +--- # swarm leave diff --git a/docs/reference/commandline/swarm_update.md b/docs/reference/commandline/swarm_update.md index 5299be257d..11362fb541 100644 --- a/docs/reference/commandline/swarm_update.md +++ b/docs/reference/commandline/swarm_update.md @@ -1,12 +1,8 @@ - +--- +title: "swarm update" +description: "The swarm update command description and usage" +keywords: ["swarm, update"] +--- # swarm update diff --git a/docs/reference/commandline/system_df.md b/docs/reference/commandline/system_df.md index 9f03dc8250..211ce4cfaf 100644 --- a/docs/reference/commandline/system_df.md +++ b/docs/reference/commandline/system_df.md @@ -1,12 +1,8 @@ - +--- +title: "system df" +description: "The system df command description and usage" +keywords: [system, data, usage, disk] +--- # system df diff --git a/docs/reference/commandline/system_prune.md b/docs/reference/commandline/system_prune.md index 3ba73ee818..393d96ed9d 100644 --- a/docs/reference/commandline/system_prune.md +++ b/docs/reference/commandline/system_prune.md @@ -1,12 +1,8 @@ - +--- +title: "system prune" +description: "Remove unused data" +keywords: [system, prune, delete, remove] +--- # system prune diff --git a/docs/reference/commandline/tag.md b/docs/reference/commandline/tag.md index 60692958f1..7154725977 100644 --- a/docs/reference/commandline/tag.md +++ b/docs/reference/commandline/tag.md @@ -1,12 +1,8 @@ - +--- +title: "tag" +description: "The tag command description and usage" +keywords: ["tag, name, image"] +--- # tag diff --git a/docs/reference/commandline/top.md b/docs/reference/commandline/top.md index 291f96ce09..9f88f97456 100644 --- a/docs/reference/commandline/top.md +++ b/docs/reference/commandline/top.md @@ -1,12 +1,8 @@ - +--- +title: "top" +description: "The top command description and usage" +keywords: ["container, running, processes"] +--- # top diff --git a/docs/reference/commandline/unpause.md b/docs/reference/commandline/unpause.md index 9795f16482..953940446c 100644 --- a/docs/reference/commandline/unpause.md +++ b/docs/reference/commandline/unpause.md @@ -1,12 +1,8 @@ - +--- +title: "unpause" +description: "The unpause command description and usage" +keywords: ["cgroups, suspend, container"] +--- # unpause diff --git a/docs/reference/commandline/update.md b/docs/reference/commandline/update.md index bacecd0106..2d5266233c 100644 --- a/docs/reference/commandline/update.md +++ b/docs/reference/commandline/update.md @@ -1,12 +1,8 @@ - +--- +title: "update" +description: "The update command description and usage" +keywords: ["resources, update, dynamically"] +--- ## update @@ -31,8 +27,8 @@ Options: ``` The `docker update` command dynamically updates container configuration. -You can use this command to prevent containers from consuming too many -resources from their Docker host. With a single command, you can place +You can use this command to prevent containers from consuming too many +resources from their Docker host. With a single command, you can place limits on a single container or on many. To specify more than one container, provide space-separated list of container names or IDs. diff --git a/docs/reference/commandline/version.md b/docs/reference/commandline/version.md index e650e41a2d..ee95e6508a 100644 --- a/docs/reference/commandline/version.md +++ b/docs/reference/commandline/version.md @@ -1,12 +1,8 @@ - +--- +title: "version" +description: "The version command description and usage" +keywords: ["version, architecture, api"] +--- # version diff --git a/docs/reference/commandline/volume_create.md b/docs/reference/commandline/volume_create.md index 65dbba2f64..b05b408736 100644 --- a/docs/reference/commandline/volume_create.md +++ b/docs/reference/commandline/volume_create.md @@ -1,12 +1,8 @@ - +--- +title: "volume create" +description: "The volume create command description and usage" +keywords: ["volume, create"] +--- # volume create @@ -57,7 +53,7 @@ different volume drivers may do different things (or nothing at all). The built-in `local` driver on Windows does not support any options. The built-in `local` driver on Linux accepts options similar to the linux `mount` command. You can provide multiple options by passing the `--opt` flag multiple times. Some `mount` options (such as the `o` option) can take a comma-separated list of options. Complete list of available mount options can be found [here](http://man7.org/linux/man-pages/man8/mount.8.html). - + For example, the following creates a `tmpfs` volume called `foo` with a size of 100 megabyte and `uid` of 1000. ```bash diff --git a/docs/reference/commandline/volume_inspect.md b/docs/reference/commandline/volume_inspect.md index fac9438e3d..dd748d2706 100644 --- a/docs/reference/commandline/volume_inspect.md +++ b/docs/reference/commandline/volume_inspect.md @@ -1,12 +1,8 @@ - +--- +title: "volume inspect" +description: "The volume inspect command description and usage" +keywords: ["volume, inspect"] +--- # volume inspect diff --git a/docs/reference/commandline/volume_ls.md b/docs/reference/commandline/volume_ls.md index 34e2ae927d..8d36ce2b87 100644 --- a/docs/reference/commandline/volume_ls.md +++ b/docs/reference/commandline/volume_ls.md @@ -1,12 +1,8 @@ - +--- +title: "volume ls" +description: "The volume ls command description and usage" +keywords: ["volume, list"] +--- # volume ls diff --git a/docs/reference/commandline/volume_prune.md b/docs/reference/commandline/volume_prune.md index 4c6eab0d53..b3db90c03c 100644 --- a/docs/reference/commandline/volume_prune.md +++ b/docs/reference/commandline/volume_prune.md @@ -1,12 +1,8 @@ - +--- +title: "volume prune" +description: "Remove unused volumes" +keywords: [volume, prune, delete] +--- # volume prune diff --git a/docs/reference/commandline/volume_rm.md b/docs/reference/commandline/volume_rm.md index aa66684259..2e5e534309 100644 --- a/docs/reference/commandline/volume_rm.md +++ b/docs/reference/commandline/volume_rm.md @@ -1,12 +1,9 @@ - +--- +title: "volume rm" +description: "the volume rm command description and usage" +keywords: ["volume, rm"] +--- + # volume rm diff --git a/docs/reference/commandline/wait.md b/docs/reference/commandline/wait.md index b6fd68dbdb..057f404d89 100644 --- a/docs/reference/commandline/wait.md +++ b/docs/reference/commandline/wait.md @@ -1,12 +1,8 @@ - +--- +title: "wait" +description: "The wait command description and usage" +keywords: ["container, stop, wait"] +--- # wait diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index d386d52bbb..2490cd6729 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -1,13 +1,8 @@ - +--- +title: "Docker Glossary" +description: "Glossary of terms used around Docker" +keywords: ["glossary, docker, terms, definitions"] +--- # Glossary diff --git a/docs/reference/index.md b/docs/reference/index.md index a207ee7d05..c634e82a2d 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -1,14 +1,8 @@ - +--- +title: "Engine reference" +description: "Docker Engine reference" +keywords: ["Engine"] +--- # Engine reference diff --git a/docs/reference/run.md b/docs/reference/run.md index 82bffc1537..6b2994cc2a 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -1,13 +1,8 @@ - +--- +title: "Docker run reference" +description: "Configure containers at runtime" +keywords: ["docker, run, configure, runtime"] +--- # Docker run reference @@ -181,7 +176,7 @@ Images using the v2 or later image format have a content-addressable identifier called a digest. As long as the input used to generate the image is unchanged, the digest value is predictable and referenceable. -The following example runs a container from the `alpine` image with the +The following example runs a container from the `alpine` image with the `sha256:9cacb71397b640eca97488cf08582ae4e4068513101088e9f96c9814bfda95e0` digest: $ docker run alpine@sha256:9cacb71397b640eca97488cf08582ae4e4068513101088e9f96c9814bfda95e0 date