Skip to content

OBSDOCS-3312: Restore restructured format for configuring-the-log-store.adoc - #116489

Merged
briandooley merged 1 commit into
openshift:standalone-logging-docs-mainfrom
johnwilkins:OBSDOCS-3312-fix-main-structure
Jul 27, 2026
Merged

OBSDOCS-3312: Restore restructured format for configuring-the-log-store.adoc#116489
briandooley merged 1 commit into
openshift:standalone-logging-docs-mainfrom
johnwilkins:OBSDOCS-3312-fix-main-structure

Conversation

@johnwilkins

@johnwilkins johnwilkins commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Summary

Fix inadvertent reversion of OBSDOCS-3312 restructuring that occurred in OBSDOCS-3539 (PR #113999).

Problem

OBSDOCS-3539 added filtering documentation on 2026-07-13, but also inadvertently reverted the OBSDOCS-3312/OBSDOCS-3551 restructuring of configuring/configuring-the-log-store.adoc. The file was changed from the simplified 6.6 format back to the pre-restructuring format with embedded sizing/storage includes.

This created an inconsistency where:

  • standalone-logging-docs-6.6 has the correct restructured format ✅
  • standalone-logging-docs-main had the old pre-restructuring format ❌

Solution

Restore the simplified format to match 6.6 structure:

  • Remove sizing/storage includes (they live in installing/ assemblies)
  • Add NOTE block pointing users to deployment sizing and storage configuration docs
  • Fix STS section leveloffset from +3 to +2
  • Add [role="_abstract"] to abstract paragraph

Structure after this fix

  • Sizing content: installing/loki-deployment-sizing.adoc
  • Storage configuration: installing/configuring-storage-for-lokistack.adoc
  • This file: Simplified with NOTE pointing to above docs

Testing

Compared resulting structure with upstream/standalone-logging-docs-6.6 to ensure consistency.

Related

Note

This PR should NOT be cherry-picked to 6.6 since 6.6 already has the correct structure.

@openshift-ci-robot

openshift-ci-robot commented Jul 24, 2026

Copy link
Copy Markdown

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

Details

In response to this:

Summary

Fix inadvertent reversion of OBSDOCS-3312 restructuring that occurred in OBSDOCS-3539 (PR #113999).

Problem

OBSDOCS-3539 added filtering documentation on 2026-07-13, but also inadvertently reverted the OBSDOCS-3312/OBSDOCS-3551 restructuring of configuring/configuring-the-log-store.adoc. The file was changed from the simplified 6.6 format back to the pre-restructuring format with embedded sizing/storage includes.

This created an inconsistency where:

  • standalone-logging-docs-6.6 has the correct restructured format ✅
  • standalone-logging-docs-main had the old pre-restructuring format ❌

Solution

Restore the simplified format to match 6.6 structure:

  • Remove sizing/storage includes (they live in installing/ assemblies)
  • Add NOTE block pointing users to deployment sizing and storage configuration docs
  • Fix STS section leveloffset from +3 to +2
  • Add [role="_abstract"] to abstract paragraph

Structure after this fix

  • Sizing content: installing/loki-deployment-sizing.adoc
  • Storage configuration: installing/configuring-storage-for-lokistack.adoc
  • This file: Simplified with NOTE pointing to above docs

Testing

Compared resulting structure with upstream/standalone-logging-docs-6.6 to ensure consistency.

Related

Note

This PR should NOT be cherry-picked to 6.6 since 6.6 already has the correct structure.

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

ocpdocs-previewbot commented Jul 24, 2026

Copy link
Copy Markdown

🤖 Mon Jul 27 15:44:33 - Prow CI generated the docs preview:

https://116489--ocpdocs-pr.netlify.app/openshift-logging/latest/configuring/configuring-the-log-store.html

…re.adoc

Fix inadvertent reversion of OBSDOCS-3312 restructuring that occurred
in OBSDOCS-3539. The file should have the simplified 6.6 format with
a NOTE block pointing to installation docs, not the pre-restructuring
format with embedded sizing/storage includes.

This brings standalone-logging-docs-main back in sync with the 6.6
structure where:
- Sizing content is in installing/loki-deployment-sizing.adoc
- Storage configuration is in installing/configuring-storage-for-lokistack.adoc
- configuring/configuring-the-log-store.adoc has simplified format with NOTE

Reference: OBSDOCS-3539 (PR openshift#113999) inadvertently reverted this
structure when adding filtering documentation on 2026-07-13.

Signed-off-by: John Wilkins <jowilkin@redhat.com>
@johnwilkins
johnwilkins force-pushed the OBSDOCS-3312-fix-main-structure branch from b3cffa4 to 15245c5 Compare July 27, 2026 15:20
@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.

@briandooley
briandooley merged commit 28c2d00 into openshift:standalone-logging-docs-main Jul 27, 2026
2 checks passed
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/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