Skip to content

OBSDOCS-3628: Fix Vale and DITA compliance issues (6.6 cherry-pick) - #116572

Merged
briandooley merged 1 commit into
openshift:standalone-logging-docs-6.6from
johnwilkins:OBSDOCS-3628-6.6
Jul 27, 2026
Merged

OBSDOCS-3628: Fix Vale and DITA compliance issues (6.6 cherry-pick)#116572
briandooley merged 1 commit into
openshift:standalone-logging-docs-6.6from
johnwilkins:OBSDOCS-3628-6.6

Conversation

@johnwilkins

@johnwilkins johnwilkins commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

OBSDOCS-3628: Fix Vale and DITA compliance issues (6.6 cherry-pick)

Manual cherry-pick of #116457 to standalone-logging-docs-6.6.

Conflicts Resolved

While not entirely clear to me, when GitHub was acting flaky recently, the modules/about-azure-logs-ingestion-api.adoc and modules/logging-forwarding-azure-logs-ingestion.adoc modules (along with 8 other Azure modules) were deleted in OBSDOCS-3539 PR. It seems like git did the rebase incorrectly or there was a workflow error.

  • OBSDOCS-3375 (merged 2026-06-XX): Intentionally added these Azure modules to document Azure Monitor Logs Ingestion API
  • OBSDOCS-3539 (merged 2026-07-14): Deleted the same Azure modules on the 6.6 release branch with no explanation

See original PR #116457 for full details.

Testing

  • Cherry-pick conflicts resolved manually
  • Azure modules restored (corrects OBSDOCS-3539 deletion)
  • 6.6 release notes structure preserved

Signed-off-by: John Wilkins jowilkin@redhat.com

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 27, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 27, 2026

Copy link
Copy Markdown

@johnwilkins: This pull request references OBSDOCS-3628 which is a valid jira issue.

Details

In response to this:

OBSDOCS-3628: Fix Vale and DITA compliance issues (6.6 cherry-pick)

Manual cherry-pick of #116457 to standalone-logging-docs-6.6.

Conflicts Resolved

1. configuring/configuring-the-log-store.adoc

Conflict: 6.6 had consolidated Loki sizing/storage into a NOTE; main has separate includes.
Resolution: Used main branch structure (separate includes) for consistency.

2. Azure Logs Ingestion API modules

Conflict: These modules were accidentally deleted in 6.6 by OBSDOCS-3539 cherry-pick (commit 76e79fd).
Resolution: Restored the modules since they should exist in 6.6:

  • modules/about-azure-logs-ingestion-api.adoc
  • modules/logging-forwarding-azure-logs-ingestion.adoc

These were originally added in OBSDOCS-3375 to document Azure Monitor Logs Ingestion API support.

3. release_notes/logging-release-notes.adoc

Conflict: Cherry-pick tried to apply 6.3.0 release notes restructure to 6.6 branch.
Resolution: Kept 6.6 structure (6.6.0 release notes) as-is.

Original PR Summary

This PR addresses Vale errors and warnings across the OpenShift Logging documentation to achieve CQA compliance and DITA compatibility.

Key improvements:

  • ✅ Fixed Vale style violations (RedHat style guide compliance)
  • ✅ Resolved AsciiDocDITA errors (nested sections, unsupported titles, task structure)
  • ✅ Deleted deprecated Elasticsearch troubleshooting content
  • ✅ Restructured release notes for DITA compliance
  • ✅ Cleaned up orphaned modules

See original PR #116457 for full details.

Testing

  • Cherry-pick conflicts resolved manually
  • Azure modules restored (corrects OBSDOCS-3539 deletion)
  • 6.6 release notes structure preserved

Signed-off-by: John Wilkins jowilkin@redhat.com

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 openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 27, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 27, 2026

Copy link
Copy Markdown

OBSDOCS-3628: Fix Vale and DITA compliance issues
@briandooley
briandooley merged commit 056a027 into openshift:standalone-logging-docs-6.6 Jul 27, 2026
2 checks passed
@openshift-ci

openshift-ci Bot commented Jul 27, 2026

Copy link
Copy Markdown

@johnwilkins: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

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. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants