docs: adding more information about terminate and stop process. Fixes: …

…#4454. (#4653) Signed-off-by: Amim Knabben <amim.knabben@gmail.com>
argoproj · Dec 7, 2020 · cbead62 · cbead62
1 parent 7eb8764
commit cbead62
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/cmd/argo/commands/stop.go b/cmd/argo/commands/stop.go
@@ -24,7 +24,7 @@ func NewStopCommand() *cobra.Command {
 
 	var command = &cobra.Command{
 		Use:   "stop WORKFLOW WORKFLOW2...",
-		Short: "stop zero or more workflows",
+		Short: "stop zero or more workflows allowing all exit handlers to run",
 		Example: `# Stop a workflow:
 
   argo stop my-wf

diff --git a/cmd/argo/commands/terminate.go b/cmd/argo/commands/terminate.go
@@ -45,7 +45,7 @@ func NewTerminateCommand() *cobra.Command {
 
 	var command = &cobra.Command{
 		Use:   "terminate WORKFLOW WORKFLOW2...",
-		Short: "terminate zero or more workflows",
+		Short: "terminate zero or more workflows immediately",
 		Example: `# Terminate a workflow:
 
   argo terminate my-wf

diff --git a/docs/cli/argo.md b/docs/cli/argo.md
@@ -116,11 +116,11 @@ NextScheduledRun assumes that the workflow-controller uses UTC as its timezone
 * [argo resume](argo_resume.md)	 - resume zero or more workflows
 * [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
+* [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 template](argo_template.md)	 - manipulate workflow templates
-* [argo terminate](argo_terminate.md)	 - terminate zero or more workflows
+* [argo terminate](argo_terminate.md)	 - terminate zero or more workflows immediately
 * [argo version](argo_version.md)	 - Print version information
 * [argo wait](argo_wait.md)	 - waits for workflows to complete
 * [argo watch](argo_watch.md)	 - watch a workflow until it completes

diff --git a/docs/cli/argo_stop.md b/docs/cli/argo_stop.md
@@ -1,10 +1,10 @@
 ## argo stop
 
-stop zero or more workflows
+stop zero or more workflows allowing all exit handlers to run
 
 ### Synopsis
 
-stop zero or more workflows
+stop zero or more workflows allowing all exit handlers to run
 
 ```
 argo stop WORKFLOW WORKFLOW2... [flags]

diff --git a/docs/cli/argo_terminate.md b/docs/cli/argo_terminate.md
@@ -1,10 +1,10 @@
 ## argo terminate
 
-terminate zero or more workflows
+terminate zero or more workflows immediately
 
 ### Synopsis
 
-terminate zero or more workflows
+terminate zero or more workflows immediately
 
 ```
 argo terminate WORKFLOW WORKFLOW2... [flags]