OBSDOCS-3693: Complete cleanup from PR #116570 split and fix Configure issues - #117163
Open
johnwilkins wants to merge 13 commits into
Open
OBSDOCS-3693: Complete cleanup from PR #116570 split and fix Configure issues#117163johnwilkins wants to merge 13 commits into
johnwilkins wants to merge 13 commits into
Conversation
… Configure issues Addresses incomplete cleanup from PR openshift#116570 and multiple Configure category issues. Root cause: PR openshift#116570 created separate focused assemblies but left duplicate content in configuring-log-forwarding.adoc, causing 10-link right-hand nav violation. Changes: 1. Remove duplicate content from configuring-log-forwarding.adoc - Removed 144 lines of duplicate sections (inputs, filters, outputs, pipelines, advanced, third-party) that now exist as separate assemblies - Added cross-reference navigation to separated assemblies - Result: 12 H2 headings → 5 H2 headings (now under 10-link limit) 2. Add cross-reference navigation to Configure assemblies - Added Additional resources sections to 6 assemblies: configuring-inputs, configuring-filters, configuring-outputs, configuring-pipelines, advanced-log-forwarding-configuration, forwarding-to-third-party-systems - Removed duplicate cross-references from modules (kept unique links) - All xrefs include proper anchor IDs (Vale compliant) 3. Fix Splunk metadata table header - Updated default-splunk-metadata-key-values.adoc table header to match format from splunk-hec-output-format.adoc - Changed from generic columns to specific: Metadata field, Infrastructure (journal), Infrastructure/Application (container), Audit logs, Notes 4. Fix CloudWatch backticks in links - Removed backticks from PutLogEvents API references in cloudwatch-output-format.adoc (line 13 and 81) - Prevents XML parsing errors from backticks in link URLs 5. Fix Vale comment syntax - Changed HTML comment syntax (<!--vale-->) to AsciiDoc syntax (// vale) - Fixes visible comments in forwarding-logs-to-amazon-s3-endpoint.adoc and cluster-logging-collector-log-forward-cloudwatch.adoc Validation: - Vale: 0 errors, 2 warnings (acceptable TaskInclude warnings with suppressions) - Heading count: configuring-log-forwarding.adoc now has 5 links (under 10 limit) - Build: Passes asciidoctor validation Related: PR openshift#116570, CCSINTL-1948 (JTBD Phase 0) Signed-off-by: John Wilkins <jowilkin@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
openshift-ci-robot
added
the
jira/valid-reference
|
@johnwilkins: This pull request references OBSDOCS-3693 which is a valid jira issue. DetailsIn response to this:
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
Bot
added
the
size/L
|
🤖 Mon Aug 03 19:38:12 - Prow CI generated the docs preview: |
…ssemblies Split the mega-assembly into logical reading progression to fix DITA's 10-link maximum (H2 + H3 combined). Created 2 new assemblies: - about-the-lokistack-log-store.adoc (7 links) - Conceptual understanding - selecting-loki-storage-provider.adoc (10 links) - Storage provider selection Revised existing assembly: - configuring-the-log-store.adoc (5 links) - Deployment procedures Changes: - Moved Loki output format, sizing, and workload identity federation to "About" assembly - Moved storage provider procedures to "Selecting storage provider" assembly - Removed duplicate tuning content (already exists in tuning-the-log-store.adoc) - Updated topic map with new assemblies in logical reading order - Added cross-references for navigation between assemblies Result: 40 links → 5 links (configuring-the-log-store) ✓ All 3 assemblies now DITA-compliant (≤10 links each) Signed-off-by: John Wilkins <jowilkin@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…t-log-store.adoc Removed cross-reference to troubleshooting/troubleshoot-log-store.adoc which doesn't exist, causing portal build failure. Signed-off-by: John Wilkins <jowilkin@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…lies Split the mega-assembly into focused assemblies to fix DITA's 10-link maximum (H2 + H3 combined). Created 4 new Configure assemblies: - about-log-store-tuning.adoc (7 links) - Prerequisites and dashboards - tuning-loki-for-performance.adoc (6 links) - Reliability and performance - tuning-loki-for-scalability.adoc (3 links) - Scalability and HA - configuring-loki-network-policies.adoc (4 links) - Network security Created 1 new Logging alerts assembly: - logging_alerts/configuring-loki-log-based-alerts.adoc (3 links) - Log-based alerts Changes: - Removed tuning-the-log-store.adoc from topic map (file still on disk) - Fixed module title: "Integrating a Loki network policy with external systems" - Fixed cross-reference to use correct ID: configuring-the-log-store - Updated topic map with new assemblies in logical reading order - Added cross-references for navigation between assemblies Result: 26 links → 23 links across 5 compliant assemblies ✓ All assemblies now DITA-compliant (≤10 links each) Signed-off-by: John Wilkins <jowilkin@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
openshift-ci
Bot
added
size/XL
Fixed references to removed tuning-the-log-store.adoc assembly: - Generic "Tuning" references → about-log-store-tuning.adoc - Dashboard references → about-log-store-tuning.adoc#understanding-lokistack-dashboards - Sizing vs scaling references → tuning-loki-for-scalability.adoc#loki-sizing-vs-component-scaling - Updated module assembly comment headers to list all new assemblies Fixed 13 files across installing, configuring, and modules directories. Signed-off-by: John Wilkins <jowilkin@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Deleted the old mega-assembly that was split into 5 focused assemblies: - about-log-store-tuning.adoc - tuning-loki-for-performance.adoc - tuning-loki-for-scalability.adoc - configuring-loki-network-policies.adoc - logging_alerts/configuring-loki-log-based-alerts.adoc The file was already removed from the topic map and all cross-references have been updated to point to the new assemblies. Signed-off-by: John Wilkins <jowilkin@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…embly Merged tuning-loki-for-performance.adoc and tuning-loki-for-scalability.adoc into tuning-loki-for-performance-and-scalability.adoc (9 links). Changes: - Created consolidated assembly with reliability, performance, and scalability topics - Updated topic map (4 tuning assemblies → 3 tuning assemblies) - Updated all cross-references to point to consolidated assembly - Updated module comment headers to reference new assembly - Deleted separate performance and scalability assemblies Result: Cleaner structure with 9 links in one assembly instead of 6+3 in two ✓ All assemblies remain DITA-compliant (≤10 links each) Signed-off-by: John Wilkins <jowilkin@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…mits
Added missing _{context} suffix to cross-reference anchor ID.
Portal build was failing with "Unknown ID or title" error.
Signed-off-by: John Wilkins <jowilkin@redhat.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…resource-limits Removed cross-reference that was causing portal build failures due to context variable expansion issues in anchor IDs. Verified with scripts/prow-smoke-test.sh - All Successful ✓ Signed-off-by: John Wilkins <jowilkin@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…pliant assemblies Split the mega-assembly into focused assemblies to fix DITA's 10-link maximum (H2 + H3 combined). Created 2 new assemblies: - forwarding-from-pods-and-projects.adoc (6 links) - Source-based filtering - forwarding-logs-over-http.adoc (8 links) - HTTP-specific implementation Revised existing assembly: - forwarding-to-third-party-systems.adoc (5 links) - Generic third-party forwarding Changes: - Moved pod/project-specific forwarding (including syslog) to new assembly - Moved HTTP output and format details to dedicated assembly - Kept OTLP, Loki, compatibility, and generic concepts in main assembly - Updated topic map with new assemblies in logical reading order - Added cross-references for navigation between assemblies Result: 19 links → 5+6+8=19 links across 3 compliant assemblies ✓ All assemblies now DITA-compliant (≤10 links each) Verified with scripts/prow-smoke-test.sh - All Successful ✓ Signed-off-by: John Wilkins <jowilkin@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…ecret procedure Removed improperly embedded "Creating a Secret" H2 section (lines 87-102) from cluster-logging-collector-log-forwarding-about.adoc CONCEPT module. Added loki-create-object-storage-secret-cli.adoc to forwarding-to-third-party-systems assembly to provide generic secret creation procedure for third-party outputs. Changes: - Removed H2 heading from CONCEPT module (violates modular docs structure) - Reused existing PROCEDURE module for secret creation - Module title mentions "Loki" but procedure is generic oc create secret - Assembly context makes it clear it's for third-party forwarding Verified with scripts/prow-smoke-test.sh - All Successful ✓ Signed-off-by: John Wilkins <jowilkin@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…t-cli"
Renamed loki-create-object-storage-secret-cli.adoc to creating-log-forwarding-secret-cli.adoc
since the procedure is generic and reused in multiple assemblies.
Changes:
- Renamed module file to reflect generic purpose
- Updated module title: "Creating a secret for log forwarding by using the CLI"
- Updated module ID to creating-log-forwarding-secret-cli_{context}
- Updated abstract to be generic (not Loki-specific)
- Updated module comment header to list both assemblies
- Updated includes in configuring-the-log-store and forwarding-to-third-party-systems
Signed-off-by: John Wilkins <jowilkin@redhat.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…e CLI" Removed "for log forwarding" from title and abstract - assembly context already makes the purpose clear. Signed-off-by: John Wilkins <jowilkin@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
@johnwilkins: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR completes the cleanup from PR #116570, which split
configuring-log-forwarding.adocinto 12 focused assemblies but left duplicate content in the original assembly. It also addresses DITA compliance violations and various formatting issues.Key changes
Fixed 10-link violation in configuring-log-forwarding.adoc (12 → 5 H2 headings)
Added consistent cross-reference navigation to Configure assemblies
Fixed Splunk table header in
default-splunk-metadata-key-values.adocFixed CloudWatch backticks in
cloudwatch-output-format.adocFixed Vale comment syntax in S3/CloudWatch modules
Removed only duplicate Additional resources links from modules
Validation
Files changed
🤖 Generated with Claude Code