docs(cli): add example for argo archive delete (#13675)

Signed-off-by: leehosu <[email protected]> Signed-off-by: l2h <[email protected]>
argoproj · Sep 30, 2024 · 2c3423e · 2c3423e
1 parent 5f70eee
commit 2c3423e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/cmd/argo/commands/archive/delete.go b/cmd/argo/commands/archive/delete.go
@@ -14,6 +14,9 @@ func NewDeleteCommand() *cobra.Command {
 	command := &cobra.Command{
 		Use:   "delete UID...",
 		Short: "delete a workflow in the archive",
+		Example: `# Delete an archived workflow by its UID:
+  argo archive delete abc123-def456-ghi789-jkl012
+`,
 		Run: func(cmd *cobra.Command, args []string) {
 			ctx, apiClient := client.NewAPIClient(cmd.Context())
 			serviceClient, err := apiClient.NewArchivedWorkflowServiceClient()

diff --git a/docs/cli/argo_archive_delete.md b/docs/cli/argo_archive_delete.md
@@ -6,6 +6,14 @@ delete a workflow in the archive
 argo archive delete UID... [flags]
 ```
 
+### Examples
+
+```
+# Delete an archived workflow by its UID:
+  argo archive delete abc123-def456-ghi789-jkl012
+
+```
+
 ### Options
 
 ```