-
Story
-
Resolution: Unresolved
-
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-run_op-tkn-reference
called Task run 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-run.adoc file:
1. LINE 19-23 from:
.Example: Cancel the `mytaskrun` task run from a namespace [source,terminal] ---- $ tkn taskrun cancel mytaskrun -n myspace ----
to:
.Example: Cancel the `mytaskrun` task run from a namespace [source,terminal] ---- $ tkn taskrun cancel <task_run_name> -n <namespace_name> ----
2. LINE 28-32 from:
.Example: Delete the `mytaskrun1` and `mytaskrun2` task runs from a namespace [source,terminal] ---- $ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace ----
to:
.Example: Delete task runs from a namespace [source,terminal] ---- $ tkn taskrun delete <task_run_name_1> <task_run_name_2> -n <namespace_name> ----
3. LINE 37 from:
$ tkn taskrun delete -n myspace --keep 5 <1>
to:
$ tkn taskrun delete -n <namespace_name> --keep 5 <1>
4. LINE 44-48 from:
.Example: Describe the `mytaskrun` task run in a namespace [source,terminal] ---- $ tkn taskrun describe mytaskrun -n myspace ----
to:
.Example: Describe a task run in a namespace [source,terminal] ---- $ tkn taskrun describe <task_run_name> -n <namespace_name> ----
5. LINE 56 from:
$ tkn taskrun list -n myspace
to:
$ tkn taskrun list -n <namespace_name>
6. LINE 63-68 from:
.Example: Display live logs for the `mytaskrun` task run in a namespace
[source,terminal]
----
$ tkn taskrun logs -f mytaskrun -n myspace
----
to:
.Example: Display live logs for the `mytaskrun` task run in a namespace
[source,terminal]
----
$ tkn taskrun logs -f <task_run_name> -n <namespace_name>
----
- clones
-
RHDEVDOCS-6145 Update Task run commands section to follow correct style
-
- QA In Progress
-
