OBSDOCS-3718: Restructure Administer category per JTBD definitions - #117401
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@johnwilkins: This pull request references OBSDOCS-3718 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/M
- Move Uninstall assemblies from Administer to Install (3 assemblies) Per official JTBD category definition, Install includes "uninstalling procedures" - Move Scheduling assembly from scheduling_resources/ to Administer (1 assembly) Day-2 operational management task - Move Alerts assemblies from logging_alerts/ to Administer (3 assemblies) Managing logging platform health (not observing applications) - Dissolve "Logging alerts" category - Dissolve "Scheduling resources" category - Update all cross-references to reflect new paths Category rationale: - Install: Full lifecycle (prerequisites → install → uninstall) - Administer: Day-2 operations (scheduling, alerts) - Troubleshoot: Reactive problem-solving (already has troubleshoot-logging-alerts) Assembly changes: - Renamed: scheduling-logging-resources → schedule-logging-resources - Renamed: default-logging-alerts → understand-default-logging-alerts - Renamed: custom-logging-alerts → configure-custom-logging-alerts - Renamed: configuring-loki-log-based-alerts → configure-log-based-alerts - Updated titles to imperative tone - Updated anchor IDs to match new filenames Signed-off-by: John Wilkins <jowilkin@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
cce8161 to
cda440e
Compare
openshift-ci
Bot
added
size/L
|
@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. |
b2f5e68
into
openshift:standalone-logging-docs-main
|
/cherrypick standalone-logging-docs-6.6 |
|
@briandooley: new pull request created: #117469 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 kubernetes-sigs/prow repository. |
5 participants
Summary
Restructures the Administer category based on official JTBD category definitions, moving Uninstall to Install and consolidating Scheduling and Alerts into Administer.
Key Changes
Categories Restructured
Assemblies Moved (7 total)
Uninstall (3): administering/ → installing/
Alerts (3): logging_alerts/ → administering/
Scheduling (1): scheduling_resources/ → administering/
Assembly Renaming
All renamed assemblies updated with:
Cross-References Updated
Rationale
Based on the official "Product documentation categories" document:
Install Includes Uninstall
Install is the full lifecycle category for getting the product in/out of your environment.
Administer is Day-2 Operations
Why Not "Observe"?
The Observe category is for using logging to observe applications. Alerts for OpenShift Logging are about managing the logging platform itself, which is administration.
Final Structure
Install (10 assemblies)
Administer (4 assemblies)
Troubleshoot (no changes)
Validation
git mvFiles Changed
Signed-off-by: John Wilkins jowilkin@redhat.com