Skip to content

Update log6x-quickstart-opentelemetry.adoc #92604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update log6x-quickstart-opentelemetry.adoc #92604

wants to merge 1 commit into from
+10 −13

Conversation

prithvipatil97
Copy link
Contributor

@prithvipatil97 prithvipatil97 commented Apr 24, 2025 •
edited
Loading

Version(s):

RHOCP-4.19, RHOCP-4.18, RHOCP-4.17, RHOCP-4.16, RHOCP-4.15

Issue:

https://issues.redhat.com/browse/OBSDOCS-1346

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

@prithvipatil97
Update log6x-quickstart-opentelemetry.adoc
2a34b68 
- Here is the link:
https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/logging/logging-6-1#quick-start-opentelemetry_logging-6x-6.1

- Problems:

  - Prerequisites are missing.
  - Operators names are not highlighted.
  - Step 4, namespace name is missing from the command
  - Step 5, namespace name is missing from the command

- 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 added namespace in the remaining 3 commands.
@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Apr 24, 2025
@ocpdocs-previewbot
Copy link

🤖 Thu Apr 24 18:28:24 - Prow CI generated the docs preview:

https://92604--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.1/log6x-about-6.1.html
https://92604--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/logging-6.2/log6x-about-6.2.html

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Apr 24, 2025

@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
Copy link
Contributor Author

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Apr 24, 2025
@maxwelldb maxwelldb added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Apr 24, 2025
@maxwelldb maxwelldb added this to the Continuous Release milestone Apr 24, 2025
@maxwelldb maxwelldb added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Apr 24, 2025
@prithvipatil97
Copy link
Contributor Author

Hello @maxwelldb ,
Thank you very much for reviewing this PR and providing approval.

Regards,
Prithviraj Patil

@prithvipatil97
Copy link
Contributor Author

Hello Team,
I need QE approval for this change.

All checks have passed and Peer review is also done.

@QiaolingTang , @anpingli , It would be really helpful if someone could please take a look and provide QE approval for this change.

Thanks in advance.

Regards,
Prithviraj Patil

@QiaolingTang
Copy link

LGTM.

@prithvipatil97
Copy link
Contributor Author

Hello QiaolingTang,
Thank you for providing the QE approval for this change.

Regards,
Prithviraj Patil

@prithvipatil97
Copy link
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Apr 25, 2025
@agantony agantony added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Apr 25, 2025
agantony
agantony reviewed Apr 25, 2025
View reviewed changes
Copy link
Contributor

@agantony agantony left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Highlighted a few style guide issues; overall lgtm!

modules/log6x-quickstart-opentelemetry.adoc
@@ -12,11 +12,13 @@ include::snippets/technology-preview.adoc[]
To configure OTLP ingestion and enable the OpenTelemetry data model, follow these steps:

.Prerequisites
* Cluster administrator permissions
* You have access to an {product-title} cluster with `cluster-admin` permissions.
* You installed the {oc-first}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* You installed the {oc-first}.
* You have installed the {oc-first}.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://redhat-documentation.github.io/supplementary-style-guide/#prerequisites

modules/log6x-quickstart-opentelemetry.adoc
* Verify that OTLP is functioning correctly by going to *Observe* -> *OpenShift Logging* -> *LokiStack* -> *Writes* in the OpenShift web console, and checking *Distributor - Structured Metadata*.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Verify that OTLP is functioning correctly by going to *Observe* -> *OpenShift Logging* -> *LokiStack* -> *Writes* in the OpenShift web console, and checking *Distributor - Structured Metadata*.
* To verify that OTLP is functioning correctly, complete the following steps:
.. In the OpenShift web console, click *Observe* -> *OpenShift Logging* -> *LokiStack* -> *Writes*.
.. Check the *Distributor - Structured Metadata* section.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://www.ibm.com/docs/en/ibm-style?topic=format-procedures#introducing-the-procedure

@agantony agantony removed the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Apr 25, 2025
@agantony
Copy link
Contributor

merge review completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agantony agantony agantony left review comments

@maxwelldb maxwelldb maxwelldb approved these changes

Assignees
No one assigned
Labels
branch/enterprise-4.15 branch/enterprise-4.16 branch/enterprise-4.17 branch/enterprise-4.18 branch/enterprise-4.19 peer-review-done Signifies that the peer review team has reviewed this PR size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
Continuous Release
Development

Successfully merging this pull request may close these issues.
5 participants
@prithvipatil97 @ocpdocs-previewbot @QiaolingTang @agantony @maxwelldb