Skip to content

chore: create Discover category with JTBD restructure#3098

Merged
gtrivedi88 merged 2 commits into
eclipse-che:mainfrom
gtrivedi88:jtbd-discover-category
Jun 16, 2026
Merged

chore: create Discover category with JTBD restructure#3098
gtrivedi88 merged 2 commits into
eclipse-che:mainfrom
gtrivedi88:jtbd-discover-category

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

Summary

  • Creates a new top-level Discover module (modules/discover/) to house architecture and platform evaluation content
  • Moves 11 pages (architecture overview, 7 server components, user workspaces, supported platforms) out of the Administration Guide
  • Adds WHY-first abstracts to all pages following JTBD methodology ("To [purpose], [action]")
  • Adds :page-aliases: for backward-compatible URL redirects from administration-guide:
  • Updates architecture diagram collector in antora.yml to target the new module
  • Updates all cross-module xrefs in administration-guide, overview, and end-user-guide

This is the second step in the JTBD category restructure (after #3077 Install), promoting evaluation content into a purpose-driven category that aligns with the user journey: Discover → Plan → Install → Administer.

Files changed

  • 31 files: 11 pages moved, 5 examples moved, 3 images moved, xrefs updated across modules

Test plan

  • Antora build succeeds with no broken xrefs
  • detect-unused-content.sh passes (no orphaned files)
  • Old URLs redirect via page-aliases
  • Discover section appears as a top-level nav category
  • Architecture diagrams render correctly in the new module

🤖 Generated with Claude Code

@gtrivedi88 gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners May 14, 2026 13:41
@gtrivedi88 gtrivedi88 requested a review from tolusha May 14, 2026 13:41
@github-actions

github-actions Bot commented May 14, 2026

Copy link
Copy Markdown

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

@github-actions

github-actions Bot commented May 14, 2026

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

Move architecture overview, server components (7 sub-pages), user
workspaces, and supported platforms from the Administration Guide
into a new top-level Discover module. This is the first step in the
JTBD category restructure — promoting evaluation and discovery
content out of the monolithic Administration Guide.

Changes:
- Create modules/discover/ with pages, examples, and images
- Add WHY-first abstracts to all 11 pages ("To [purpose], [action]")
- Add page-aliases for backward-compatible URLs from admin-guide
- Update antora.yml: register discover nav, move architecture
  diagram collector to discover module
- Update all cross-module xrefs in admin-guide, overview modules
- Remove Discover entries from administration-guide nav.adoc

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gtrivedi88 gtrivedi88 force-pushed the jtbd-discover-category branch from 529d751 to 5362c7a Compare May 14, 2026 20:19
gtrivedi88 added a commit to gtrivedi88/che-docs that referenced this pull request May 14, 2026
Move all installation pages, partials, and examples from
administration-guide to a new modules/install/ module, matching the
downstream JTBD category structure. Create installation overview,
verification, and next-steps pages. Update all cross-module xrefs
and includes across admin-guide, overview, and end-user-guide.
Delete dissolved wrapper pages (preparing-the-installation,
permissions-to-install-che). Register discover, plan, and install
module navs in antora.yml.

Depends on: PR eclipse-che#3098 (Discover), PR eclipse-che#3099 (Plan)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
gtrivedi88 added a commit to gtrivedi88/che-docs that referenced this pull request May 14, 2026
Move all installation pages, partials, and examples from
administration-guide to a new modules/install/ module, matching the
downstream JTBD category structure. Create installation overview,
verification, and next-steps pages. Update all cross-module xrefs
and includes across admin-guide, overview, and end-user-guide.
Delete dissolved wrapper pages (preparing-the-installation,
permissions-to-install-che). Register discover, plan, and install
module navs in antora.yml.

Depends on: PR eclipse-che#3098 (Discover), PR eclipse-che#3099 (Plan)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
gtrivedi88 added a commit to gtrivedi88/che-docs that referenced this pull request May 14, 2026
Move all installation pages, partials, and examples from
administration-guide to a new modules/install/ module, matching the
downstream JTBD category structure. Create installation overview,
verification, and next-steps pages. Update all cross-module xrefs
and includes across admin-guide, overview, and end-user-guide.
Delete dissolved wrapper pages (preparing-the-installation,
permissions-to-install-che). Register discover, plan, and install
module navs in antora.yml.

Depends on: PR eclipse-che#3098 (Discover), PR eclipse-che#3099 (Plan)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
gtrivedi88 added a commit to gtrivedi88/che-docs that referenced this pull request May 18, 2026
Move all installation pages, partials, and examples from
administration-guide to a new modules/install/ module, matching the
downstream JTBD category structure. Create installation overview,
verification, and next-steps pages. Update all cross-module xrefs
and includes across admin-guide, overview, and end-user-guide.
Delete dissolved wrapper pages (preparing-the-installation,
permissions-to-install-che). Register discover, plan, and install
module navs in antora.yml.

Depends on: PR eclipse-che#3098 (Discover), PR eclipse-che#3099 (Plan)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gtrivedi88

Copy link
Copy Markdown
Contributor Author

@ibuziuk @svor Could you please help assign and review?

@ibuziuk ibuziuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we make Discover the first top-level section and include it there:

  • Introduction to Che
  • Eclipse Che hosted by Red Hat

Addresses SME feedback from ibuziuk on PR eclipse-che#3098:
- Move Discover to first position in navigation
- Include 'Introduction to Che' and 'Eclipse Che hosted by Red Hat' in Discover section
- Remove redundant overview and hosted-che from main nav (content accessible via Discover)
- Logical user flow: Discover → Use → Administer

This creates a better user journey where users first discover what Eclipse Che
is and explore hosted options before diving into detailed architecture.

Co-Authored-By: Claude Sonnet 4 <noreply@anthropic.com>

@rgrunber rgrunber left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine to me.

@gtrivedi88 gtrivedi88 merged commit 2a817c1 into eclipse-che:main Jun 16, 2026
6 checks passed
gtrivedi88 added a commit to gtrivedi88/che-docs that referenced this pull request Jun 16, 2026
Move all installation pages, partials, and examples from
administration-guide to a new modules/install/ module, matching the
downstream JTBD category structure. Create installation overview,
verification, and next-steps pages. Update all cross-module xrefs
and includes across admin-guide, overview, and end-user-guide.
Delete dissolved wrapper pages (preparing-the-installation,
permissions-to-install-che). Register discover, plan, and install
module navs in antora.yml.

Depends on: PR eclipse-che#3098 (Discover), PR eclipse-che#3099 (Plan)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
gtrivedi88 added a commit that referenced this pull request Jun 16, 2026
* chore: promote Install to top-level Antora module

Move all installation pages, partials, and examples from
administration-guide to a new modules/install/ module, matching the
downstream JTBD category structure. Create installation overview,
verification, and next-steps pages. Update all cross-module xrefs
and includes across admin-guide, overview, and end-user-guide.
Delete dissolved wrapper pages (preparing-the-installation,
permissions-to-install-che). Register discover, plan, and install
module navs in antora.yml.

Depends on: PR #3098 (Discover), PR #3099 (Plan)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* chore: merge Plan content into Install module, retire Plan

Move calculating-che-resource-requirements, running-at-scale, and
installing-the-chectl-management-tool from administration-guide into
the install module. This merges what was planned as a separate Plan
module (PR #3099) directly into Install, matching the downstream
decision to retire the Plan guide.

- Move 3 pages, 4 examples, 1 image to modules/install/
- Add running-at-scale to install/nav.adoc Requirements section
- Update admin-guide nav to remove moved entries
- Convert cross-module xrefs: admin-guide refs to install become local
- Add plan: page-aliases for backward-compatible redirects

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
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.

3 participants