Skip to content

chore: promote Install to top-level Antora module#3102

Open
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:jtbd-install-category
Open

chore: promote Install to top-level Antora module#3102
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:jtbd-install-category

Conversation

@gtrivedi88
Copy link
Copy Markdown
Contributor

Summary

  • Move all installation pages (16), partials (18), and examples (2) from modules/administration-guide/ to a new modules/install/ Antora module
  • Create 3 new pages matching downstream structure: installation overview (con_installation-overview), verification (proc_verifying-the-installation), next steps (con_next-steps-after-installation)
  • Update abstracts and descriptions for CQA 2.1 compliance with JTBD WHY-first patterns
  • Add :page-aliases: for backward-compatible URL redirects on all moved pages
  • Update all cross-module xrefs (25+ files across admin-guide, overview, end-user-guide) and cross-module includes
  • Delete dissolved thin wrapper pages (preparing-the-installation.adoc, permissions-to-install-che.adoc)
  • Register discover, plan, and install module navs in antora.yml
  • Structure install/nav.adoc as a JTBD user journey: Overview → Requirements → Deploy → Verify → Next Steps → Uninstall

Dependencies

This PR depends on the following PRs merging first (cross-module xrefs reference their modules):

Test plan

  • Verify Antora build completes without xref warnings
  • Confirm all :page-aliases: generate proper redirects
  • Check Install nav renders correctly in the site navigation
  • Verify cross-module xrefs from admin-guide to install pages resolve
  • Verify cross-module includes (restricted env partials, installation-instructions snippet) resolve

🤖 Generated with Claude Code

@gtrivedi88 gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners May 14, 2026 20:59
@gtrivedi88 gtrivedi88 requested a review from amisevsk May 14, 2026 20:59
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 14, 2026

⚡️ Deploying pull request preview...

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 14, 2026

Click here to review and test in web IDE: Contribute

@gtrivedi88 gtrivedi88 force-pushed the jtbd-install-category branch from 69df6fa to 58dfba6 Compare May 14, 2026 21:04
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 gtrivedi88 force-pushed the jtbd-install-category branch from 58dfba6 to cfe3a3b Compare May 14, 2026 21:16
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