Skip to content
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.

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

OBSDOCS-1767: Fix logging docs build in OCP 4.17 #90184

Open
wants to merge 1 commit into
base: logging-docs-6.2-4.17
Choose a base branch
from

Conversation

theashiot
Copy link
Contributor

@theashiot theashiot commented Mar 12, 2025

Version(s): needs to be merged to logging-docs-6.2-4.17 where the PR is currently pointing to

Issue: https://issues.redhat.com/browse/OBSDOCS-1767

Link to docs preview:

QE review: QE review not required.

Additional information:
This PR is to fix validation errors in #90136
Please note that this is not new content. This PR simply copies an existing file: https://github.com/openshift/openshift-docs/blob/4acdbc7beb85c37078c91905be646795111e9728/observability/logging/logging_release_notes/cluster-logging-support.adoc?plain=1 to another directory without making any content changes.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Mar 12, 2025

@theashiot: This pull request references OBSDOCS-1767 which is a valid jira issue.

In response to this:

Version(s): needs to be merged to logging-docs-6.2-4.17 where the PR is currently pointing to

Issue: https://issues.redhat.com/browse/OBSDOCS-1767

Link to docs preview:

QE review: QE review not required.

Additional information:
This PR is to fix validation errors in #90136

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Mar 12, 2025
@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 12, 2025
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Mar 12, 2025

🤖 Thu Mar 13 09:33:53 - Prow CI generated the docs preview:

https://90184--ocpdocs-pr.netlify.app/

@theashiot
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 Mar 12, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Mar 13, 2025

@theashiot: This pull request references OBSDOCS-1767 which is a valid jira issue.

In response to this:

Version(s): needs to be merged to logging-docs-6.2-4.17 where the PR is currently pointing to

Issue: https://issues.redhat.com/browse/OBSDOCS-1767

Link to docs preview:

QE review: QE review not required.

Additional information:
This PR is to fix validation errors in #90136
Please note that this is not new content. This PR simply copies an existing file to another directory without making any content changes.

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Mar 13, 2025

@theashiot: This pull request references OBSDOCS-1767 which is a valid jira issue.

In response to this:

Version(s): needs to be merged to logging-docs-6.2-4.17 where the PR is currently pointing to

Issue: https://issues.redhat.com/browse/OBSDOCS-1767

Link to docs preview:

QE review: QE review not required.

Additional information:
This PR is to fix validation errors in #90136
Please note that this is not new content. This PR simply copies an existing file: https://github.com/openshift/openshift-docs/blob/4acdbc7beb85c37078c91905be646795111e9728/observability/logging/logging_release_notes/cluster-logging-support.adoc?plain=1 to another directory without making any content changes.

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 openshift-eng/jira-lifecycle-plugin repository.

@xenolinux xenolinux added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Mar 13, 2025
Copy link
Contributor

@xenolinux xenolinux left a comment

Choose a reason for hiding this comment

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

Pretty minor nits; otherwise LGTM

include::snippets/logging-compatibility-snip.adoc[]
include::snippets/log6x-loki-statement-snip.adoc[]

{logging-uc} {for} is an opinionated collector and normalizer of application, infrastructure, and audit logs. It is intended to be used for forwarding logs to various supported systems.
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
{logging-uc} {for} is an opinionated collector and normalizer of application, infrastructure, and audit logs. It is intended to be used for forwarding logs to various supported systems.
{logging-uc} {for} is an opinionated collector and normalizer of application, infrastructure, and audit logs. You can use it to forward logs to various supported systems.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

[id="support-exception-for-coo-logging-ui-plugin_{context}"]
== Support exception for the Logging UI Plugin

Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its Logging UI Plugin on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA.
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
Until the approaching General Availability (GA) release of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its Logging UI Plugin on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA.
Until the General Availability (GA) of the Cluster Observability Operator (COO), which is currently in link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] (TP), Red{nbsp}Hat provides support to customers who are using Logging 6.0 or later with the COO for its Logging UI Plugin on {product-title} 4.14 or later. This support exception is temporary as the COO includes several independent features, some of which are still TP features, but the Logging UI Plugin is ready for GA.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

@xenolinux xenolinux 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 labels Mar 13, 2025
@theashiot
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 Mar 13, 2025
Copy link

openshift-ci bot commented Mar 13, 2025

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

@theashiot
Copy link
Contributor Author

Thanks a lot @xenolinux for the review, i've made all the required changes.

@xenolinux xenolinux 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 Mar 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. merge-review-in-progress Signifies that the merge review team is reviewing this PR peer-review-done Signifies that the peer review team has reviewed this PR size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants