Browse Source

Merge pull request #27363 from tealtail/26227-add-stack-ps-to-docs

add documentation for `docker stack ps`, Fixes #26227
Sebastiaan van Stijn 8 years ago
parent
commit
e8e1c4dfb9

+ 1 - 1
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)

+ 1 - 1
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)

+ 1 - 1
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)

+ 6 - 6
docs/reference/commandline/stack_tasks.md → docs/reference/commandline/stack_ps.md

@@ -1,26 +1,26 @@
 <!--[metadata]>
 +++
-title = "stack tasks"
-description = "The stack tasks command description and usage"
-keywords = ["stack, tasks"]
+title = "stack ps"
+description = "The stack ps command description and usage"
+keywords = ["stack, ps"]
 advisory = "experimental"
 [menu.main]
 parent = "smn_cli"
 +++
 <![end-metadata]-->
 
-# 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

+ 1 - 1
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)

+ 2 - 2
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)