docs(cli): a stopped workflow cannot be resumed (#11624)

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
argoproj · Sep 1, 2023 · 12da114 · 12da114
1 parent 5d23844
commit 12da114
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/cmd/argo/commands/resume.go b/cmd/argo/commands/resume.go
@@ -21,8 +21,8 @@ func NewResumeCommand() *cobra.Command {
 
 	command := &cobra.Command{
 		Use:   "resume WORKFLOW1 WORKFLOW2...",
-		Short: "resume zero or more workflows",
-		Example: `# Resume a workflow that has been stopped or suspended:
+		Short: "resume zero or more workflows (opposite of suspend)",
+		Example: `# Resume a workflow that has been suspended:
 
   argo resume my-wf
 

diff --git a/cmd/argo/commands/suspend.go b/cmd/argo/commands/suspend.go
@@ -13,7 +13,7 @@ import (
 func NewSuspendCommand() *cobra.Command {
 	command := &cobra.Command{
 		Use:   "suspend WORKFLOW1 WORKFLOW2...",
-		Short: "suspend zero or more workflow",
+		Short: "suspend zero or more workflows (opposite of resume)",
 		Example: `# Suspend a workflow:
 
   argo suspend my-wf

diff --git a/docs/cli/argo.md b/docs/cli/argo.md
@@ -117,12 +117,12 @@ argo [flags]
 * [argo logs](argo_logs.md)	 - view logs of a pod or workflow
 * [argo node](argo_node.md)	 - perform action on a node in a workflow
 * [argo resubmit](argo_resubmit.md)	 - resubmit one or more workflows
-* [argo resume](argo_resume.md)	 - resume zero or more workflows
+* [argo resume](argo_resume.md)	 - resume zero or more workflows (opposite of suspend)
 * [argo retry](argo_retry.md)	 - retry zero or more workflows
 * [argo server](argo_server.md)	 - start the Argo Server
 * [argo stop](argo_stop.md)	 - stop zero or more workflows allowing all exit handlers to run
 * [argo submit](argo_submit.md)	 - submit a workflow
-* [argo suspend](argo_suspend.md)	 - suspend zero or more workflow
+* [argo suspend](argo_suspend.md)	 - suspend zero or more workflows (opposite of resume)
 * [argo template](argo_template.md)	 - manipulate workflow templates
 * [argo terminate](argo_terminate.md)	 - terminate zero or more workflows immediately
 * [argo version](argo_version.md)	 - print version information

diff --git a/docs/cli/argo_resume.md b/docs/cli/argo_resume.md
@@ -1,6 +1,6 @@
 ## argo resume
 
-resume zero or more workflows
+resume zero or more workflows (opposite of suspend)
 
 ```
 argo resume WORKFLOW1 WORKFLOW2... [flags]
@@ -9,7 +9,7 @@ argo resume WORKFLOW1 WORKFLOW2... [flags]
 ### Examples
 
 ```
-# Resume a workflow that has been stopped or suspended:
+# Resume a workflow that has been suspended:
 
   argo resume my-wf
 

diff --git a/docs/cli/argo_suspend.md b/docs/cli/argo_suspend.md
@@ -1,6 +1,6 @@
 ## argo suspend
 
-suspend zero or more workflow
+suspend zero or more workflows (opposite of resume)
 
 ```
 argo suspend WORKFLOW1 WORKFLOW2... [flags]