OBSDOCS-3567: Remove duplicate and obsolete Loki sizing section#114576
Conversation
|
@johnwilkins: This pull request references OBSDOCS-3567 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. |
|
🤖 Thu Jul 02 18:58:43 - Prow CI generated the docs preview: https://114576--ocpdocs-pr.netlify.app/ |
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>
|
@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. |
f0bc7a7
into
openshift:standalone-logging-docs-main
|
@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. |
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:
Obsolete information:
modules/loki-deployment-sizing.adoc) was missing the1x.picot-shirt sizeSolution
✅ 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 4Before:
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:
Note on DITA Warnings
Vale shows 6 DITA warnings about the xref being in a NOTE instead of Additional resources. This is acceptable because:
Testing
Related
Signed-off-by: John Wilkins jowilkin@redhat.com
🤖 Generated with Claude Code