Skip to content

feat: JTBD audit Upgrade module — overview concept, persona cleanup, user journey#3148

Open
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:fix-upgrade-jtbd-title
Open

feat: JTBD audit Upgrade module — overview concept, persona cleanup, user journey#3148
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:fix-upgrade-jtbd-title

Conversation

@gtrivedi88

@gtrivedi88 gtrivedi88 commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Full JTBD audit of the Upgrade module, benchmarked against Ansible AAP and RHDH upgrade guide patterns.

  • Transform upgrading-che.adoc from thin assembly shell into rich overview concept (how the upgrade works, supported paths, pre-upgrade checklist)
  • Remove snip_persona-admin.adoc includes from all 6 pages (JTBD checklist: NO generic persona snippets)
  • Fix meta-commentary ("This section describes...") with WHAT+WHY abstracts
  • Fix gerund title: "Upgrading the chectl..." to "Update the chectl..."
  • Add [role="_abstract"] and WHAT+WHY pattern to all pages
  • Fix content types: approval strategy and web console from ASSEMBLY to PROCEDURE
  • Reorder nav: overview > approval strategy > web console > chectl update > CLI > air-gapped > DWO repair
  • Delete unused partials/snip_persona-admin.adoc

Changes

File Change
pages/upgrading-che.adoc Assembly shell → rich overview concept with how-it-works, supported paths, pre-upgrade checklist
pages/specifying-the-update-approval-strategy.adoc Remove persona snippet, add abstract, fix content type to PROCEDURE
pages/upgrading-che-using-the-web-console.adoc Remove persona snippet, add WHAT+WHY abstract, fix content type to PROCEDURE
pages/upgrading-che-using-the-cli-management-tool.adoc Remove persona snippet, fix meta-commentary abstract
pages/upgrading-che-using-the-cli-management-tool-in-restricted-environment.adoc Remove persona snippet, fix meta-commentary abstract
pages/upgrading-the-chectl-management-tool.adoc Remove persona snippet, fix gerund title
pages/repairing-the-devworkspace-operator-on-openshift.adoc Remove persona snippet, add abstract
examples/snip_che-upgrading-the-chectl-management-tool.adoc Fix meta-commentary abstract
nav.adoc Reorder: chectl update before CLI upgrade
partials/snip_persona-admin.adoc Deleted (no longer used)

Zero content loss — all existing procedure steps, code blocks, and technical details preserved.

Test plan

  • Cluster-tested on DS 3.29.0 (ROSA, OCP 4.21.9)
  • Antora build succeeds
  • Old admin-guide URLs redirect via page-aliases
  • No broken xrefs across modules
  • Vale lint passes

Made with Cursor

@gtrivedi88 gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners July 3, 2026 11:27
@gtrivedi88 gtrivedi88 requested a review from ibuziuk July 3, 2026 11:27
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown

🎊 Navigate the preview: https://6a51952ea64fe8a51a396059--eclipse-che-docs-pr.netlify.app 🎊

@gtrivedi88 gtrivedi88 force-pushed the fix-upgrade-jtbd-title branch 2 times, most recently from c987528 to b107dde Compare July 7, 2026 09:16
…user journey

Transform Upgrade module from a thin assembly shell into a complete JTBD guide:

Overview concept (upgrading-che.adoc):
- How the upgrade works (Operator handles server components, DWO)
- Supported upgrade path (previous minor to current)
- Pre-upgrade checklist (5-step, review release notes to update chectl)

Content quality fixes:
- Remove snip_persona-admin.adoc includes from all 6 pages (checklist: NO generic snippets)
- Fix meta-commentary: "This section describes..." to WHAT+WHY abstracts
- Fix gerund title: "Upgrading the chectl..." to "Update the chectl..."
- Add [role="_abstract"] and WHAT+WHY pattern to all pages
- Fix content types: approval strategy and web console changed from ASSEMBLY to PROCEDURE
- Update descriptions and keywords for search optimization

Navigation reorder (user journey):
- Overview to approval strategy to web console to chectl update to CLI to air-gapped to DWO repair
- chectl update moved before CLI upgrade (prerequisite ordering)

Cluster-tested on DS 3.29.0 (ROSA, OCP 4.21.9):
- DWO v0.42.0 Succeeded, single entry
- Subscription Automatic approval in openshift-operators

Co-authored-by: Cursor <cursoragent@cursor.com>
@gtrivedi88 gtrivedi88 force-pushed the fix-upgrade-jtbd-title branch from b107dde to e7a148c Compare July 10, 2026 22:22
@gtrivedi88 gtrivedi88 changed the title fix: apply JTBD title to Upgrade module feat: JTBD audit Upgrade module — overview concept, persona cleanup, user journey Jul 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant