Commit c637344
Installation - Update installing-logging-operator-cli.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
~~~1 parent 73e9e23 commit c637344
1 file changed
+8
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
79 | 79 | | |
80 | 80 | | |
81 | 81 | | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
82 | 86 | | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
83 | 91 | | |
84 | 92 | | |
85 | 93 | | |
| |||
0 commit comments