Skip to content

OBSDOCS-3721: Restructure for Pantheon JTBD publishing - #117505

Merged
briandooley merged 1 commit into
openshift:standalone-logging-docs-mainfrom
johnwilkins:OBSDOCS-3721
Aug 7, 2026
Merged

OBSDOCS-3721: Restructure for Pantheon JTBD publishing#117505
briandooley merged 1 commit into
openshift:standalone-logging-docs-mainfrom
johnwilkins:OBSDOCS-3721

Conversation

@johnwilkins

@johnwilkins johnwilkins commented Aug 7, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Summary

Restructures OpenShift Logging documentation to support Pantheon publishing while aligning with JTBD framework for AEM migration.

Issue: #117505
Version: 6.6 (cherry pick to standalone-loggging-docs-6.6)
Preview: https://117505--ocpdocs-pr.netlify.app/openshift-logging/latest/administer-alerts/configure-custom-logging-alerts.html

Changes

  • Directory restructuring: Split combined categories into separate Pantheon titles
  • JTBD alignment: Renamed directories to imperative forms (Discover, Install, Configure, etc.)
  • Upgrade completion: Finished Upgrade section restructuring
  • Cross-references: Updated all xrefs and module metadata to new paths

Directory Changes

  • about/ → discover/
  • installing/ → install/ (uninstall content moved to separate directory)
  • configuring/ → configure/
  • administering/ → split into administer-scheduling/ + administer-alerts/
  • troubleshooting/ → troubleshoot/
  • upgrading/ → upgrade/

Pantheon Titles (8 total)

  1. Discover (discover/)
  2. Install (install/)
  3. Uninstall (uninstall/)
  4. Configure (configure/)
  5. Scheduling resources (administer-scheduling/)
  6. Alerts (administer-alerts/)
  7. Upgrade (upgrade/)
  8. Troubleshoot (troubleshoot/)

Testing

  • ✅ All new directories validate successfully in prow test
  • ✅ Cross-references updated to new paths
  • ✅ Module metadata updated
  • ✅ Topic map updated

Follow-up

  • After merge, cherry-pick to standalone-logging-docs-6.6
  • Update Pantheon UI configuration with new directory names
  • Update _work/job-mapping-category.ods spreadsheet with new paths (separate task)
  • Vale linting cleanup (separate PR)

Pantheon Configuration Updates Needed

After merge, update Pantheon UI for each title:

  • "About OpenShift logging" → Content Directory: discover (was about)
  • "Installing logging" → Content Directory: install (was installing)
  • Add new: "Uninstall" → Content Directory: uninstall
  • "Configuring logging" → Content Directory: configure (was configuring)
  • Add new: "Scheduling resources" → Content Directory: administer-scheduling
  • Add new: "Alerts" → Content Directory: administer-alerts
  • Delete: "Scheduling resources" (old, obsolete)
  • Delete: "Logging alerts" (old, obsolete)
  • "Upgrading logging" → Content Directory: upgrade (was upgrading)
  • Add new: "Troubleshoot" → Content Directory: troubleshoot

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

@openshift-ci-robot

openshift-ci-robot commented Aug 7, 2026 •
edited by openshift-ci Bot
Loading

Copy link
Copy Markdown

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

Details

In response to this:

Summary

Restructures OpenShift Logging documentation to support Pantheon publishing while aligning with JTBD framework for AEM migration.

Changes

  • Directory restructuring: Split combined categories into separate Pantheon titles
  • JTBD alignment: Renamed directories to imperative forms (Discover, Install, Configure, etc.)
  • Upgrade completion: Finished Upgrade section restructuring
  • Cross-references: Updated all xrefs and module metadata to new paths

Directory Changes

  • about/ → discover/
  • installing/ → install/ (uninstall content moved to separate directory)
  • configuring/ → configure/
  • administering/ → split into administer-scheduling/ + administer-alerts/
  • troubleshooting/ → troubleshoot/
  • upgrading/ → upgrade/

Pantheon Titles (8 total)

  1. Discover (discover/)
  2. Install (install/)
  3. Uninstall (uninstall/)
  4. Configure (configure/)
  5. Scheduling resources (administer-scheduling/)
  6. Alerts (administer-alerts/)
  7. Upgrade (upgrade/)
  8. Troubleshoot (troubleshoot/)

Testing

  • ✅ All new directories validate successfully in prow test
  • ✅ Cross-references updated to new paths
  • ✅ Module metadata updated
  • ✅ Topic map updated

Follow-up

  • After merge, cherry-pick to standalone-logging-docs-6.6
  • Update Pantheon UI configuration with new directory names
  • Update _work/job-mapping-category.ods spreadsheet with new paths (separate task)
  • Vale linting cleanup (separate PR)

Pantheon Configuration Updates Needed

After merge, update Pantheon UI for each title:

  • "About OpenShift logging" → Content Directory: discover (was about)
  • "Installing logging" → Content Directory: install (was installing)
  • Add new: "Uninstall" → Content Directory: uninstall
  • "Configuring logging" → Content Directory: configure (was configuring)
  • Add new: "Scheduling resources" → Content Directory: administer-scheduling
  • Add new: "Alerts" → Content Directory: administer-alerts
  • Delete: "Scheduling resources" (old, obsolete)
  • Delete: "Logging alerts" (old, obsolete)
  • "Upgrading logging" → Content Directory: upgrade (was upgrading)
  • Add new: "Troubleshoot" → Content Directory: troubleshoot

🤖 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-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Aug 7, 2026
@openshift-ci openshift-ci Bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Aug 7, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Aug 7, 2026 •
edited
Loading

Copy link
Copy Markdown

🤖 Fri Aug 07 15:16:39 - Prow CI generated the docs preview:
https://117505--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

@johnwilkins
johnwilkins force-pushed the OBSDOCS-3721 branch 2 times, most recently from 31da2b5 to 6736f4c Compare August 7, 2026 15:09
@johnwilkins @claude
OBSDOCS-3721: Restructure for Pantheon JTBD publishing
2ea22e7 
This commit restructures the documentation to support both Pantheon
publishing and future AEM migration:

- Split combined directories (1 directory = 1 Pantheon title)
- Renamed directories to JTBD imperative forms
- Completed Upgrade section restructuring
- Updated all cross-references and module metadata

Changes:
- Renamed: about/ → discover/
- Renamed: installing/ → install/
- Renamed: configuring/ → configure/
- Renamed: troubleshooting/ → troubleshoot/
- Renamed: upgrading/ → upgrade/
- Split: administering/ → administer-scheduling/ + administer-alerts/
- Split: install/ → install/ + uninstall/
- Deleted: logging_alerts/, scheduling_resources/, uninstalling/, administering/
- Updated: _topic_maps/_topic_map.yml
- Updated: All docinfo.xml files with JTBD titles
- Updated: All cross-references to new directory paths
- Updated: All module metadata paths

Pantheon Titles (8 total):
1. Discover (discover/)
2. Install (install/)
3. Uninstall (uninstall/)
4. Configure (configure/)
5. Scheduling resources (administer-scheduling/)
6. Alerts (administer-alerts/)
7. Upgrade (upgrade/)
8. Troubleshoot (troubleshoot/)

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

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@openshift-ci

openshift-ci Bot commented Aug 7, 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 b6fb634 into openshift:standalone-logging-docs-main Aug 7, 2026
2 checks passed
@briandooley

briandooley commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

/cherrypick standalone-logging-docs-6.6

@openshift-cherrypick-robot

openshift-cherrypick-robot commented Aug 7, 2026

Copy link
Copy Markdown

@briandooley: new pull request created: #117538

Details

In response to this:

/cherrypick standalone-logging-docs-6.6

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.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Aug 7, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@johnwilkins @openshift-ci-robot @ocpdocs-previewbot @briandooley @openshift-cherrypick-robot