[OBSDOCS-2662] Installation - Update installing-logging-operator-cli.adoc #101291
Conversation
…adoc - Several commands are included within a single code block. Here is the documentation link: https://docs.redhat.com/en/documentation/red_hat_openshift_logging/6.3/html/installing_logging/installing-logging#installing-logging-operator-cli_installing-logging - As per the standard rule, using more than one command per code block is not recommended. - Please check Standard rule [2] for reference: [2] https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#single-command-per-code-block - When commands are bunched together, the copy to clipboard functionality might not break the lines up correctly. - Using a single command per code block makes it copy-and-paste friendly. - Hence, we need to mention 3 separate code blocks for above 3 commands. Here is the updated look of the documentation: ~~~ $ oc adm policy add-cluster-role-to-user logging-collector-logs-writer -z logging-collector -n openshift-logging ~~~ ~~~ $ oc adm policy add-cluster-role-to-user collect-application-logs -z logging-collector -n openshift-logging ~~~ ~~~ $ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z logging-collector -n openshift-logging ~~~
openshift-ci
bot
added
the
size/XS
|
🤖 Wed Oct 29 11:56:51 - Prow CI generated the docs preview: https://101291--ocpdocs-pr.netlify.app/openshift-logging/latest/installing/installing-logging.html |
|
@prithvipatil97: 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. |
|
Hello Team, All checks have passed, and I have reviewed the PR with the peer review checklist. @anpingli , @QiaolingTang , it would be really helpful if someone could please take a look and provide QE approval for this change. Thanks in advance. Regards, |
|
/lgtm |
|
Hello anpingli, Regards, |
|
/label merge-review-needed |
openshift-ci
bot
added
the
merge-review-needed
jeana-redhat
added
merge-review-in-progress
briandooley
merged commit a5a5944
into
openshift:standalone-logging-docs-main
|
/cherrypick standalone-logging-docs-6.0 |
|
/cherrypick standalone-logging-docs-6.1 |
|
/cherrypick standalone-logging-docs-6.2 |
|
/cherrypick standalone-logging-docs-6.3 |
|
/cherrypick standalone-logging-docs-6.4 |
|
@briandooley: new pull request created: #101915 In response to this:
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. |
|
@briandooley: new pull request created: #101916 In response to this:
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. |
|
@briandooley: new pull request created: #101917 In response to this:
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. |
|
@briandooley: new pull request created: #101918 In response to this:
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. |
|
@briandooley: new pull request created: #101919 In response to this:
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. |
6 participants
Several commands are included within a single code block.
Here is the documentation link:
https://docs.redhat.com/en/documentation/red_hat_openshift_logging/6.3/html/installing_logging/installing-logging#installing-logging-operator-cli_installing-logging
As per the standard rule, using more than one command per code block is not recommended.
Please check Standard rule [2] for reference:
[2] https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#single-command-per-code-block
When commands are bunched together, the copy to clipboard functionality might not break the lines up correctly.
Using a single command per code block makes it copy-and-paste friendly.
Hence, we need to mention 3 separate code blocks for above 3 commands. Here is the updated look of the documentation:
Version(s):
Logging 6.4, Logging 6.3, Logging 6.2, Logging 6.1, Logging 6.0
Issue:
https://issues.redhat.com/browse/OBSDOCS-2662
Link to docs preview:
QE review:
Additional information: