Skip to content

Commit 020a8f3

Browse files
authored
RHDEVDOCS-6145: Replaced specific task name and namespace name with placeholders for clarity
1 parent 9796c75 commit 020a8f3

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

modules/op-tkn-task-run.adoc

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
// This module is included in the following assemblies:
2+
//
23
// * tkn_cli/op-tkn-reference.adoc
34

5+
:_mod-docs-content-type: REFERENCE
46
[id="op-tkn-task-run_{context}"]
57
= Task run commands
68

@@ -16,35 +18,35 @@ $ tkn taskrun -h
1618
== taskrun cancel
1719
Cancel a task run.
1820

19-
.Example: Cancel the `mytaskrun` task run from a namespace
21+
.Example: Cancel a task run from a namespace
2022
[source,terminal]
2123
----
22-
$ tkn taskrun cancel mytaskrun -n myspace
24+
$ tkn taskrun cancel <task_run_name> -n <namespace_name>
2325
----
2426

2527
== taskrun delete
2628
Delete a TaskRun.
2729

28-
.Example: Delete the `mytaskrun1` and `mytaskrun2` task runs from a namespace
30+
.Example: Delete task runs from a namespace
2931
[source,terminal]
30-
----
31-
$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace
32+
----
33+
$ tkn taskrun delete <task_run_name_1> <task_run_name_2> -n <namespace_name>
3234
----
3335

3436
.Example: Delete all but the five most recently executed task runs from a namespace
3537
[source,terminal]
3638
----
37-
$ tkn taskrun delete -n myspace --keep 5 <1>
39+
$ tkn taskrun delete -n <namespace_name> --keep 5 <1>
3840
----
3941
<1> Replace `5` with the number of most recently executed task runs you want to retain.
4042

4143
== taskrun describe
4244
Describe a task run.
4345

44-
.Example: Describe the `mytaskrun` task run in a namespace
46+
.Example: Describe a task run in a namespace
4547
[source,terminal]
4648
----
47-
$ tkn taskrun describe mytaskrun -n myspace
49+
$ tkn taskrun describe <task_run_name> -n <namespace_name>
4850
----
4951

5052
== taskrun list
@@ -53,16 +55,16 @@ List task runs.
5355
.Example: List all the task runs in a namespace
5456
[source,terminal]
5557
----
56-
$ tkn taskrun list -n myspace
58+
$ tkn taskrun list -n <namespace_name>
5759
----
5860

5961

6062
== taskrun logs
6163
Display task run logs.
6264

63-
.Example: Display live logs for the `mytaskrun` task run in a namespace
65+
.Example: Display live logs for a task run in a namespace
6466

6567
[source,terminal]
6668
----
67-
$ tkn taskrun logs -f mytaskrun -n myspace
69+
$ tkn taskrun logs -f <task_run_name> -n <namespace_name>
6870
----

0 commit comments

Comments
 (0)