Update logging 6.1 quick start with ViaQ - log6x-quickstart-viaq.adoc #88600
Conversation
- Here is the link: https://docs.openshift.com/container-platform/4.16/observability/logging/logging-6.1/log6x-about-6.1.html#quick-start-viaq_{context} - Problems: - Prerequisites are missing. - Operators names are not highlighted. - Step 4, namespace name is missing from the command - Step 5, all commands are separated. - We are performing the following changes through this PR: - Added required Prerequisites. - Highlighted the Operator's names in Step 1. - Namespace name is added in the Step 4 - Removed $ oc project openshift-logging, and combined all command from Step 5 in a single unit, and added namespace name at the end.
openshift-ci
bot
added
the
size/S
|
🤖 Thu Feb 13 23:46:05 - Prow CI generated the docs preview: |
|
@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. |
|
/label peer-review-needed |
openshift-ci
bot
added
the
peer-review-needed
xenolinux
added
peer-review-in-progress
| $ oc adm policy add-cluster-role-to-user collect-application-logs -z collector -n openshift-logging | ||
| $ oc adm policy add-cluster-role-to-user collect-audit-logs -z collector -n openshift-logging | ||
| $ oc adm policy add-cluster-role-to-user collect-infrastructure-logs -z collector -n openshift-logging |
There was a problem hiding this comment.
The old version (commands in a separate code blocks) is correct.
- Consider reverting this change. See https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#single-command-per-code-block
Do not use more than one command per code block.
- Commands need to have an instruction for them. See https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#procedure-step-that-introduces-a-command
| ==== | ||
|
|
||
| . Allow the collector's service account to collect logs: | ||
| + |
There was a problem hiding this comment.
Allow the collector's service account to collect logs: --> can be updated to something like --> To collect logs, use the service account of the collector by running the following command:
I know this PR doesn't touch this line, but FYI:
Avoid using "allow": https://www.ibm.com/docs/en/ibm-style?topic=word-usage#a
Avoid stating that inanimate objects grant abilities to people, as in “the product allows you to…”. Whenever possible, use a direct, user-focused alternative such as “you can use the product to…” or “with this product, users can…”.
https://www.ibm.com/docs/en/ibm-style?topic=grammar-possessives
Do not use possessive ’s with inanimate objects.
xenolinux
added
peer-review-done
|
Thanks for this suggestion. |
3 participants
Here is the link:
https://docs.openshift.com/container-platform/4.16/observability/logging/logging-6.1/log6x-about-6.1.html#quick-start-viaq_{context}
Problems:
We are performing the following changes through this PR:
Version(s):
RHOCP-4.18, RHOCP-4.17, RHOCP-4.16, RHOCP-4.15, RHOCP-4.14
Issue:
https://issues.redhat.com/browse/OBSDOCS-1346
Link to docs preview:
https://88600--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.1/log6x-about-6.1.html
QE review:
Additional information: