[standalone-logging-docs-6.3] [OBSDOCS-2662] Installation - Update installing-logging-operator-cli.adoc #101918
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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 ~~~
1 task
openshift-ci
bot
added
the
size/XS
|
@openshift-cherrypick-robot: 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. |
briandooley
merged commit 2515097
into
openshift:standalone-logging-docs-6.3
2 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an automated cherry-pick of #101291
/assign briandooley