-
Notifications
You must be signed in to change notification settings - Fork 1.8k
RHDEVDOCS#6145: Replaced specific task name and namespace name with placeholders for clarity #81790
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…lders for clarity
Hi @kalyaniverma. Thanks for your PR. I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
/ok-to-test |
🤖 Mon Sep 16 09:42:12 - Prow CI generated the docs preview: https://81790--ocpdocs-pr.netlify.app/openshift-pipelines/latest/tkn_cli/op-tkn-reference.html |
@kalyaniverma: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello @kalyaniverma I added two comments, for line 19 and 63 that need to be edited. The rest looks good.
However, there is one more issue, I notice you created your feature branch against pipelines-docs-1.15
, it needs to be created against pipelines-docs-main
. So you will have to create a new feature branch against the right branch and raise a new PR again. Please also incorporate the feedback I left.
Thank you! 🙂
== taskrun cancel | ||
Cancel a task run. | ||
|
||
.Example: Cancel the `mytaskrun` task run from a namespace |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.Example: Cancel the `mytaskrun` task run from a namespace | |
.Example: Cancel a task run from a namespace |
Display task run logs. | ||
|
||
.Example: Display live logs for the `mytaskrun` task run in a namespace | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change a line 63 from:
.Example: Display live logs for the `mytaskrun` task run in a namespace
to:
.Example: Display live logs for a task run in a namespace
Good job! I have a suggestion about the content type attribute. Please implement the suggestion given. After L2, leave a line. Before L4, add this attribute: For more information, see: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#content-type-attributes and https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#module-file-metadata. Thanks, @kalyaniverma. |
This PR replaces specific task names and namespace names with placeholders in the Task run commands for better clarity
No new information is added. Therefore, no QE review is necessary.
Version(s):
Issue:
Link to docs preview:
QE review:
Additional information: