Prerequisites are missing from Update log6x-about.adoc

[prithvipatil97]

• Here is the link: https://docs.openshift.com/container-platform/4.16/observability/logging/logging-6.0/log6x-about.html#quick-start

• Problems:

  • Quick Start indentation is wrong.
  • Prerequisites are missing.
  • Adding link to Step 6.

• We are performing the following changes through this PR:

  • Corrected Quick Start indentation, it should be in line with Validation.
  • Added required Prerequisites.
  • Added installation guideline link in the Step 6. Install the Cluster Observability Operator.

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://87991--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.0/log6x-about.html

QE review:

• QE has approved this change.

Additional information:

[ocpdocs-previewbot]

🤖 Tue Feb 04 19:28:57 - Prow CI generated the docs preview:

https://87991--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.0/log6x-about.html

[ocpdocs-vale-bot]

🤖 [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]

/label peer-review-needed

[eromanova97]

/remove-label peer-review-needed

/label peer-review-in-progress

[eromanova97]

I left some small 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!

[eromanova97]

I understand why you use link here instead of xref (to avoid xrefs in a module), however, I am not sure if this is the best practice, even more with the decommisioning of docs.openshift (which will probably break these links).

I would consider leaving this as it was and instead adding an additional resources section after the module in an assembly, where you would link this correctly with xref

[role="_additional-resources"]
.Additional resources
* xref:../

[eromanova97]

Also, the Cluster Observability Operator has an attribute you can use here: {coo-full}

[dfitzmau]

I agree, @eromanova97 . Excellent review!

[prithvipatil97]

Hello @eromanova97 ,
Thanks for your attention here in peer review.

I apologize for the inconvenience caused.
I understand the suggested changes.

Thank you again,

Regard,
Prithviraj Patil

[openshift-ci]

@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.

[prithvipatil97]

Hello @eromanova97 ,
I have successfully committed first change:

This is a patch-29:

Here is the push command output for both the commit:

[pripatil@supportshell-1 openshift-docs]$ git push origin HEAD --force
Username for 'https://github.com': prithvipatil97
Password for 'https://prithvipatil97@github.com': 
Enumerating objects: 11, done.
Counting objects: 100% (11/11), done.
Delta compression using up to 32 threads
Compressing objects: 100% (6/6), done.
Writing objects: 100% (6/6), 1.19 KiB | 1.19 MiB/s, done.
Total 6 (delta 5), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (5/5), completed with 5 local objects.
To https://github.com/prithvipatil97/openshift-docs
 + 1cc483517e...1358e1d3d7 HEAD -> patch-29 (forced update)         <<===

[pripatil@supportshell-1 openshift-docs]$ git push origin HEAD --force
Username for 'https://github.com': prithvipatil97
Password for 'https://prithvipatil97@github.com': 
Enumerating objects: 11, done.
Counting objects: 100% (11/11), done.
Delta compression using up to 32 threads
Compressing objects: 100% (6/6), done.
Writing objects: 100% (6/6), 1.21 KiB | 1.21 MiB/s, done.
Total 6 (delta 5), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (5/5), completed with 5 local objects.
To https://github.com/prithvipatil97/openshift-docs
 + 3edb34a4f6...f9484e27cf HEAD -> patch-29 (forced update)       <<===

Kindly have a look and let me know, if it is correct now.
Also, please confirm if we are good to proceed further.

Regards,
Prithviraj Patil

[prithvipatil97]

Hello Team,
Thanks for your help here.
I have committed the suggested changes.
But we found some other points to be changed from same documentation.
Hence I am closing this PR and we will continue with new PR with all the suggested points.
Here is the new PR Link: #88424

Thanks again.

Regards,
Prithviraj Patil