Logging 6.1 Prerequisites missing log6x-quickstart-viaq.adoc #87992
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. - We are performing the following changes through this PR: - Added required Prerequisites. - Highlighted the Operator's names in Step 1.
openshift-ci
bot
added
the
size/XS
|
🤖 Mon Feb 03 23:37:38 - Prow CI generated the docs preview: |
| * Cluster administrator permissions | ||
| * You have administrator permissions. | ||
| * You installed the OpenShift CLI (oc). | ||
| * You have access to a supported object store. For example: AWS S3, Google Cloud Storage, Azure, Swift, Minio, or OpenShift Data Foundation. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{rh-storage}' rather than the plain text product term 'OpenShift Data Foundation', unless your use case is an exception.
|
@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
|
/remove-label peer-review-needed /label peer-review-in-progress |
openshift-ci
bot
added
peer-review-in-progress
There was a problem hiding this comment.
I left some minor comments, otherwise looks good to me!
However, as I am new to peer review squad, please wait for @dfitzmau to review again and for the peer-review-done label before proceeding. Thank you!
| .Prerequisites | ||
| * Cluster administrator permissions | ||
| * You have administrator permissions. | ||
| * You installed the OpenShift CLI (oc). |
There was a problem hiding this comment.
| * You installed the OpenShift CLI (oc). | |
| * You installed the {oc-first}. |
We can use an attribute here.
There was a problem hiding this comment.
Hello @eromanova97 ,
Thanks for your attention here in peer review.
I understand your point.
I apologize for the inconvenience caused.
I understand the suggested changes; I will try to commit these changes.
Thank you again,
Regard,
Prithviraj Patil
| * Cluster administrator permissions | ||
| * You have administrator permissions. | ||
| * You installed the OpenShift CLI (oc). | ||
| * You have access to a supported object store. For example: AWS S3, Google Cloud Storage, Azure, Swift, Minio, or OpenShift Data Foundation. |
There was a problem hiding this comment.
| * You have access to a supported object store. For example: AWS S3, Google Cloud Storage, Azure, Swift, Minio, or OpenShift Data Foundation. | |
| * You have access to a supported object store. For example, AWS S3, Google Cloud Storage, {azure-short}, Swift, Minio, or {rh-storage}. |
We can use attributes here.
There was a problem hiding this comment.
Hello @eromanova97 ,
Thanks for your attention here in peer review.
I understand your point.
But I have taken this point from our standard RedHat Documentation.
I apologize for the inconvenience caused.
I understand the suggested changes; I will try to commit these changes.
Thank you again,
Regard,
Prithviraj Patil
| To use the default ViaQ data model, follow these steps: | ||
|
|
||
| .Prerequisites | ||
| * Cluster administrator permissions |
There was a problem hiding this comment.
One out of scope comment: I noticed that another chapter in this assembly, "Quick start with OpenTelemetry", has the same prerequisite: "Cluster administrator permissions" so it would be great to also change that to: "You have administrator permissions." for consistency, plus check if any prerequisites are missing there too.
However, I saw that there is more than one PR similar to this, so this might already be addressed elsewere, I just wanted to point that out just in case 👍
|
Excellent review, @eromanova97 . Thank you! |
dfitzmau
added
peer-review-done
|
Hello Team, Regards, |
5 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://87992--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.1/log6x-about-6.1.html
QE review:
Additional information: