From 970ab9a224658e17894a7673189ad9d2491a592d Mon Sep 17 00:00:00 2001 From: Alicia Lauerman Date: Thu, 13 Oct 2016 15:03:08 -0400 Subject: [PATCH] add documentation for `docker stack ps` also updates related stack docs and removes stack_tasks.md Signed-off-by: Alicia Lauerman --- docs/reference/commandline/stack_config.md | 2 +- docs/reference/commandline/stack_deploy.md | 2 +- docs/reference/commandline/stack_ls.md | 2 +- .../commandline/{stack_tasks.md => stack_ps.md} | 12 ++++++------ docs/reference/commandline/stack_rm.md | 2 +- docs/reference/commandline/stack_services.md | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) rename docs/reference/commandline/{stack_tasks.md => stack_ps.md} (82%) diff --git a/docs/reference/commandline/stack_config.md b/docs/reference/commandline/stack_config.md index 9a39d27116..a7b8f6f5b8 100644 --- a/docs/reference/commandline/stack_config.md +++ b/docs/reference/commandline/stack_config.md @@ -28,5 +28,5 @@ Displays the configuration of a stack. * [stack deploy](stack_deploy.md) * [stack rm](stack_rm.md) * [stack services](stack_services.md) -* [stack tasks](stack_tasks.md) +* [stack ps](stack_ps.md) * [stack ls](stack_ls.md) diff --git a/docs/reference/commandline/stack_deploy.md b/docs/reference/commandline/stack_deploy.md index bcafb7f686..7f3c341ae3 100644 --- a/docs/reference/commandline/stack_deploy.md +++ b/docs/reference/commandline/stack_deploy.md @@ -57,5 +57,5 @@ axqh55ipl40h vossibility-stack_vossibility-collector 1 icecrime/vossibility-co * [stack config](stack_config.md) * [stack rm](stack_rm.md) * [stack services](stack_services.md) -* [stack tasks](stack_tasks.md) +* [stack ps](stack_ps.md) * [stack ls](stack_ls.md) diff --git a/docs/reference/commandline/stack_ls.md b/docs/reference/commandline/stack_ls.md index 11abc34727..acd570214c 100644 --- a/docs/reference/commandline/stack_ls.md +++ b/docs/reference/commandline/stack_ls.md @@ -34,4 +34,4 @@ myapp 2 * [stack config](stack_config.md) * [stack deploy](stack_deploy.md) * [stack rm](stack_rm.md) -* [stack tasks](stack_tasks.md) +* [stack ps](stack_ps.md) diff --git a/docs/reference/commandline/stack_tasks.md b/docs/reference/commandline/stack_ps.md similarity index 82% rename from docs/reference/commandline/stack_tasks.md rename to docs/reference/commandline/stack_ps.md index 24b00e69cc..bc71b2e4d9 100644 --- a/docs/reference/commandline/stack_tasks.md +++ b/docs/reference/commandline/stack_ps.md @@ -1,26 +1,26 @@ -# stack tasks (experimental) +# stack ps (experimental) ```markdown -Usage: docker stack tasks [OPTIONS] STACK +Usage: docker stack ps [OPTIONS] STACK List the tasks in the stack Options: -a, --all Display all tasks -f, --filter value Filter output based on conditions provided - --help Print usage --no-resolve Do not map IDs to Names + --no-trunc Do not truncate output ``` Lists the tasks that are running as part of the specified stack. This diff --git a/docs/reference/commandline/stack_rm.md b/docs/reference/commandline/stack_rm.md index 5d4e4d57be..8aae98c162 100644 --- a/docs/reference/commandline/stack_rm.md +++ b/docs/reference/commandline/stack_rm.md @@ -31,5 +31,5 @@ a manager node. * [stack config](stack_config.md) * [stack deploy](stack_deploy.md) * [stack services](stack_services.md) -* [stack tasks](stack_tasks.md) +* [stack ps](stack_ps.md) * [stack ls](stack_ls.md) diff --git a/docs/reference/commandline/stack_services.md b/docs/reference/commandline/stack_services.md index 8f28410bf3..ed44d6b1d4 100644 --- a/docs/reference/commandline/stack_services.md +++ b/docs/reference/commandline/stack_services.md @@ -39,7 +39,7 @@ dn7m7nhhfb9y myapp_db 1/1 mysql@sha256:a9a5b559f8821fe73d58c3606c8 The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there is more than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`). -Multiple filter flags are combined as an `OR` filter. +Multiple filter flags are combined as an `OR` filter. The following command shows both the `web` and `db` services: @@ -62,5 +62,5 @@ The currently supported filters are: * [stack config](stack_config.md) * [stack deploy](stack_deploy.md) * [stack rm](stack_rm.md) -* [stack tasks](stack_tasks.md) +* [stack ps](stack_ps.md) * [stack ls](stack_ls.md)