-
Story
-
Resolution: Done
-
High
-
3
-
False
-
-
False
-
-
-
Sprint 1, Sprint 2
We need to update this section: https://docs.openshift.com/pipelines/1.15/tkn_cli/op-tkn-reference.html#op-tkn-task-management_op-tkn-reference
called Task management commands so that it follows our style guide.
Raise the PR against pipelines-docs-main branch. Cherry-pick branches are pipelines-docs-1.14, pipelines-docs-1.15, and pipelines-docs-1.16.
Please make the following changes in the op-tkn-task-management.adoc file:
1. LINE 19-23 from:
.Example: Delete `mytask1` and `mytask2` tasks from a namespace [source,terminal] ---- $ tkn task delete mytask1 mytask2 -n myspace ----
to:
.Example: Delete tasks from a namespace [source,terminal] ---- $ tkn task delete <task_name_1> <task_name_2> -n <namespace_name> ----
2. LINE 28-32 from:
.Example: Describe the `mytask` task in a namespace [source,terminal] ---- $ tkn task describe mytask -n myspace ----
to:
.Example: Describe a task in a namespace [source,terminal] ---- $ tkn task describe <task_name> -n <namespace_name> ----
3. LINE 40 from:
$ tkn task list -n myspace
to:
$ tkn task list -n <namespace_name>
4. LINE 46-50 from:
.Example: Display logs for the `mytaskrun` task run of the `mytask` task
[source,terminal]
----
$ tkn task logs mytask mytaskrun -n myspace
----
to:
.Example: Display logs for a task run of a task
[source,terminal]
----
$ tkn task logs <task_name> <task_run_name> -n <namespace_name>
----
5. LINE 55-59 from:
.Example: Start the `mytask` task in a namespace [source,terminal] ---- $ tkn task start mytask -s <ServiceAccountName> -n myspace ----
to:
.Example: Start a task in a namespace [source,terminal] ---- $ tkn task start <task_name> -s <service_account_name> -n <namespace_name> ----
- clones
-
RHDEVDOCS-6144 Update Task management commands section to follow correct style
-
- Closed
-
