Skip to content

OBSDOCS-3567: Remove duplicate and obsolete Loki sizing section#114576

Merged
briandooley merged 1 commit into
openshift:standalone-logging-docs-mainfrom
johnwilkins:OBSDOCS-3567
Jul 3, 2026
Merged

OBSDOCS-3567: Remove duplicate and obsolete Loki sizing section#114576
briandooley merged 1 commit into
openshift:standalone-logging-docs-mainfrom
johnwilkins:OBSDOCS-3567

Conversation

@johnwilkins

@johnwilkins johnwilkins commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Summary

Removes duplicate and obsolete Loki deployment sizing content from the Loki Operator installation guide and replaces it with a link to the comprehensive Chapter 4 sizing guide.

Problem

Duplicate content:

  • Section 5.1 "Loki deployment sizing" in the Loki Operator installation guide
  • Chapter 4 "Loki deployment sizing" (comprehensive guide)

Obsolete information:

  • The embedded module (modules/loki-deployment-sizing.adoc) was missing the 1x.pico t-shirt size
  • Table did not reflect current sizing options
  • Created confusion with two conflicting sources of sizing information

Solution

✅ Removed include::modules/loki-deployment-sizing.adoc[leveloffset=+1]
✅ Added NOTE block directing users to the comprehensive sizing chapter
✅ Single source of truth for Loki sizing guidance

Changes

Modified:

  • installing/installing-the-loki-operator.adoc: Replaced sizing module include with NOTE containing xref to Chapter 4

Before:
Users saw an incomplete sizing table embedded in the installation procedure.

After:
Users are directed to review the comprehensive sizing guide before installation, which includes:

  • All current t-shirt sizes (1x.pico, 1x.demo, 1x.extra-small, 1x.small, 1x.medium)
  • Per-component resource breakdowns
  • Sizing interpretation guidance
  • Current recommendations

Note on DITA Warnings

Vale shows 6 DITA warnings about the xref being in a NOTE instead of Additional resources. This is acceptable because:

  • The link serves as prerequisite guidance before installation
  • Inline placement improves user experience (users see it before starting installation)
  • This pattern is common for prerequisite/planning information

Testing

  • ✅ Vale: 0 errors, 6 DITA warnings (acceptable - see above)
  • ✅ Xref target verified (loki-deployment-sizing.adoc exists)
  • ✅ NOTE placement tested for user flow

Related

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

🤖 Generated with Claude Code

@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 2, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 2, 2026

Copy link
Copy Markdown

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

Details

In response to this:

Summary

Removes duplicate and obsolete Loki deployment sizing content from the Loki Operator installation guide and replaces it with a link to the comprehensive Chapter 4 sizing guide.

Problem

Duplicate content:

  • Section 5.1 "Loki deployment sizing" in the Loki Operator installation guide
  • Chapter 4 "Loki deployment sizing" (comprehensive guide)

Obsolete information:

  • The embedded module (modules/loki-deployment-sizing.adoc) was missing the 1x.pico t-shirt size
  • Table did not reflect current sizing options
  • Created confusion with two conflicting sources of sizing information

Solution

✅ Removed include::modules/loki-deployment-sizing.adoc[leveloffset=+1]
✅ Added NOTE block directing users to the comprehensive sizing chapter
✅ Single source of truth for Loki sizing guidance

Changes

Modified:

  • installing/installing-the-loki-operator.adoc: Replaced sizing module include with NOTE containing xref to Chapter 4

Before:
Users saw an incomplete sizing table embedded in the installation procedure.

After:
Users are directed to review the comprehensive sizing guide before installation, which includes:

  • All current t-shirt sizes (1x.pico, 1x.demo, 1x.extra-small, 1x.small, 1x.medium)
  • Per-component resource breakdowns
  • Sizing interpretation guidance
  • Current recommendations

Note on DITA Warnings

Vale shows 6 DITA warnings about the xref being in a NOTE instead of Additional resources. This is acceptable because:

  • The link serves as prerequisite guidance before installation
  • Inline placement improves user experience (users see it before starting installation)
  • This pattern is common for prerequisite/planning information

Testing

  • ✅ Vale: 0 errors, 6 DITA warnings (acceptable - see above)
  • ✅ Xref target verified (loki-deployment-sizing.adoc exists)
  • ✅ NOTE placement tested for user flow

Related

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

🤖 Generated with Claude Code

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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 2, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 2, 2026

Copy link
Copy Markdown

@openshift-ci openshift-ci Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 2, 2026
Removed the duplicate and obsolete Loki deployment sizing module from
the repository. The module was outdated (missing 1x.pico) and no longer
used anywhere.

Issue:
- Section 5.1 in the Loki Operator installation guide duplicated
  content from Chapter 4 (Loki deployment sizing)
- The embedded module was obsolete (missing 1x.pico t-shirt size)
- Created confusion with two sources of sizing information
- Module was orphaned (not included in any assemblies)

Resolution:
- Removed include of modules/loki-deployment-sizing.adoc from assembly
- Deleted orphaned module file (not used elsewhere in the repo)
- Added NOTE block directing users to review sizing before installation
- Moved "Next steps" section content into Additional resources (DITA compliance)
- Added xref to comprehensive sizing chapter in Additional resources
- Users now have a single source of truth for Loki sizing

The comprehensive sizing guide (Chapter 4: installing/loki-deployment-sizing.adoc)
contains:
- All current t-shirt sizes including 1x.pico
- Detailed per-component resource breakdowns
- Sizing interpretation guidance
- Up-to-date recommendations

Vale results: 0 errors, 0 warnings, 9 suggestions (style only)
DITA compliance: Fully compliant

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

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@openshift-ci openshift-ci Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 2, 2026
@openshift-ci

openshift-ci Bot commented Jul 2, 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 f0bc7a7 into openshift:standalone-logging-docs-main Jul 3, 2026
2 checks passed
@johnwilkins

Copy link
Copy Markdown
Contributor Author

@briandooley Can we cherry pick those to 6.6, 6.5, and 6.4. My apologies. I forgot to add that to the PR. Now that the IA is relatively stable, the auto cherry picking seems to work better now. Let me know if it doesn't work, and I'll send some manual cherry picks your way.

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