Skip to content

chore: promote Configure to top-level Antora module (JTBD Phase 4)#3155

Open
gtrivedi88 wants to merge 2 commits into
eclipse-che:mainfrom
gtrivedi88:jtbd-configure-fresh
Open

chore: promote Configure to top-level Antora module (JTBD Phase 4)#3155
gtrivedi88 wants to merge 2 commits into
eclipse-che:mainfrom
gtrivedi88:jtbd-configure-fresh

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

What does this pull request change?

Creates a new top-level modules/configure/ Antora module by extracting all configuration content from administration-guide. Replaces stale PR #3132.

43 pages, 8 partials moved.

Nav structure (3 domain sections)

  1. Configure the platform — CheCluster CR, server components, dashboard, API
  2. Configure workspaces — namespace provisioning, workspace policies
  3. Configure networking and storage — networking, storage, fuse-overlayfs, backup

Changes

  • Administration-guide nav slimmed to security-best-practices only
  • page-aliases added for all 43 moved pages
  • antora.yml updated with configure nav

Supersedes #3132. Please close #3132 after merging this PR.

Pull Request checklist

  • No procedure changes — moves only
  • All pages contain :page-aliases: for backward-compatible URLs
  • Zero content loss

Made with Cursor

@gtrivedi88 gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners July 6, 2026 06:54
@gtrivedi88 gtrivedi88 requested a review from ibuziuk July 6, 2026 06:55
@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

⚡️ Deploying pull request preview...

@gtrivedi88 gtrivedi88 force-pushed the jtbd-configure-fresh branch 15 times, most recently from 50d2b68 to 38efad8 Compare July 10, 2026 21:21
…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 → current)
- Pre-upgrade checklist (5-step, review release notes → 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..." → WHAT+WHY abstracts
- Fix gerund title: "Upgrading the chectl..." → "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 → approval strategy → web console → chectl update → CLI → air-gapped → 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 jtbd-configure-fresh branch 2 times, most recently from b3fd272 to 57ba42c Compare July 10, 2026 22:59
Align upstream with downstream JTBD audit:
- Update :description: attributes to match downstream WHAT+WHY abstracts
- Fix title: "Enable container run capabilities" -> "Run nested containers
  in workspaces"
- Fix :navtitle: to match updated titles
- Fix extraProperties vs customCheProperties inconsistency

Co-authored-by: Cursor <cursoragent@cursor.com>
@gtrivedi88 gtrivedi88 force-pushed the jtbd-configure-fresh branch from 57ba42c to 5efd268 Compare July 11, 2026 01:44
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