docs(cli): clarify the difference b/t retry and resubmit (#11625)

argoproj · Sep 5, 2023 · f3000b9 · f3000b9
1 parent 408a0a4
commit f3000b9
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/cmd/argo/commands/resubmit.go b/cmd/argo/commands/resubmit.go
@@ -37,6 +37,7 @@ func NewResubmitCommand() *cobra.Command {
 	command := &cobra.Command{
 		Use:   "resubmit [WORKFLOW...]",
 		Short: "resubmit one or more workflows",
+		Long:  "Submit a completed workflow again. Optionally override parameters and memoize. Similar to running `argo submit` again with the same parameters.",
 		Example: `# Resubmit a workflow:
 
   argo resubmit my-wf

diff --git a/cmd/argo/commands/retry.go b/cmd/argo/commands/retry.go
@@ -40,11 +40,12 @@ func NewRetryCommand() *cobra.Command {
 	command := &cobra.Command{
 		Use:   "retry [WORKFLOW...]",
 		Short: "retry zero or more workflows",
+		Long:  "Rerun a failed Workflow. Specifically, rerun all failed steps. The same Workflow object is used and no new Workflows are created.",
 		Example: `# Retry a workflow:
 
   argo retry my-wf
 
-# Retry multiple workflows: 
+# Retry multiple workflows:
 
   argo retry my-wf my-other-wf my-third-wf
 

diff --git a/docs/cli/argo_resubmit.md b/docs/cli/argo_resubmit.md
@@ -2,6 +2,10 @@
 
 resubmit one or more workflows
 
+### Synopsis
+
+Submit a completed workflow again. Optionally override parameters and memoize. Similar to running `argo submit` again with the same parameters.
+
 ```
 argo resubmit [WORKFLOW...] [flags]
 ```

diff --git a/docs/cli/argo_retry.md b/docs/cli/argo_retry.md
@@ -2,6 +2,10 @@
 
 retry zero or more workflows
 
+### Synopsis
+
+Rerun a failed Workflow. Specifically, rerun all failed steps. The same Workflow object is used and no new Workflows are created.
+
 ```
 argo retry [WORKFLOW...] [flags]
 ```
@@ -13,7 +17,7 @@ argo retry [WORKFLOW...] [flags]
 
   argo retry my-wf
 
-# Retry multiple workflows: 
+# Retry multiple workflows:
 
   argo retry my-wf my-other-wf my-third-wf