Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add more information about terminate and stop process #4653

Merged
merged 3 commits into from
Dec 7, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/argo/commands/stop.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/argo/commands/terminate.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/argo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/argo_stop.md
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/argo_terminate.md
Original file line number Diff line number Diff line change
@@ -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]
Expand Down