Skip to content

Commit 675b80c

Browse files
Merge pull request #82249 from Karnadevsinh/RHDEVDOCS-6144
RHDEVDOCS-6144: Update Task management commands section to follow correct style
2 parents a1f4abd + bb4896a commit 675b80c

File tree

1 file changed

+8
-16
lines changed

1 file changed

+8
-16
lines changed

modules/op-tkn-task-management.adoc

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

4+
:_mod-docs-content-type: REFERENCE
45
[id="op-tkn-task-management_{context}"]
56
= Task management commands
67

@@ -16,19 +17,19 @@ $ tkn task -h
1617
== task delete
1718
Delete a task.
1819

19-
.Example: Delete `mytask1` and `mytask2` tasks from a namespace
20+
.Example: Delete tasks from a namespace
2021
[source,terminal]
2122
----
22-
$ tkn task delete mytask1 mytask2 -n myspace
23+
$ tkn task delete <task_name_1> <task_name_2> -n <namespace_name>
2324
----
2425

2526
== task describe
2627
Describe a task.
2728

28-
.Example: Describe the `mytask` task in a namespace
29+
.Example: Describe a task in a namespace
2930
[source,terminal]
3031
----
31-
$ tkn task describe mytask -n myspace
32+
$ tkn task describe <task_name> -n <namespace_name>
3233
----
3334

3435
== task list
@@ -37,23 +38,14 @@ List tasks.
3738
.Example: List all the tasks in a namespace
3839
[source,terminal]
3940
----
40-
$ tkn task list -n myspace
41-
----
42-
43-
== task logs
44-
Display task logs.
45-
46-
.Example: Display logs for the `mytaskrun` task run of the `mytask` task
47-
[source,terminal]
48-
----
49-
$ tkn task logs mytask mytaskrun -n myspace
41+
$ tkn task list -n <namespace_name>
5042
----
5143

5244
== task start
5345
Start a task.
5446

55-
.Example: Start the `mytask` task in a namespace
47+
.Example: Start a task in a namespace
5648
[source,terminal]
5749
----
58-
$ tkn task start mytask -s <ServiceAccountName> -n myspace
50+
$ tkn task start <task_name> -s <service_account_name> -n <namespace_name>
5951
----

0 commit comments

Comments
 (0)