Skip to content

chore: promote Configure to top-level Antora module (JTBD Phase 2)#3132

Open
gtrivedi88 wants to merge 5 commits into
eclipse-che:mainfrom
gtrivedi88:jtbd-configure-category
Open

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

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

Summary

  • Promote configuration content from Administration Guide into modules/configure/
  • Follows CCS category definition: Configure = 'Adjust system or product settings'
  • Mirrors downstream devspaces-documentation structure (shipped in DS 3.29)

Dependency

Depends on #3098 (Discover) and #3102 (Install) which are already merged.

Changes

  • New modules/configure/ with nav.adoc, 76 pages, examples, partials, images
  • Updated antora.yml with configure nav and collector base path
  • Slimmed administration-guide nav (keeps Security, Observability, Upgrading)
  • Cross-module xrefs updated across admin-guide, discover, install, end-user-guide
  • page-aliases added for backward-compatible URLs from old admin-guide paths

Test plan

  • Antora build succeeds
  • Old admin-guide URLs redirect via page-aliases
  • Configure nav renders correctly
  • No broken xrefs across modules

Made with Cursor

Move configuration content from Administration Guide into a new
modules/configure/ Antora module, following the CCS 'Configure'
category: 'Adjust system or product settings to meet desired behavior.'

9 JTBD jobs: CheCluster CR, Namespaces, Server components, Networking,
Storage, Dashboard, Workspaces globally, Autoscaling/Caching, IDE extensions.

- Create modules/configure/ with nav, pages, examples, partials
- Move 76 pages from administration-guide
- Add page-aliases for backward-compatible redirects
- Update cross-module xrefs in admin-guide, discover, install, end-user-guide
- Add modules/configure/nav.adoc to antora.yml
- Update collector base path for checluster-properties

Mirrors downstream devspaces-documentation commit 298bcfe5.

Co-authored-by: Cursor <cursoragent@cursor.com>
@gtrivedi88 gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners June 26, 2026 14:12
@gtrivedi88 gtrivedi88 requested a review from tolusha June 26, 2026 14:12
@github-actions

github-actions Bot commented Jun 26, 2026

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

@github-actions

Copy link
Copy Markdown

⚡️ Deploying pull request preview...

@gtrivedi88

Copy link
Copy Markdown
Contributor Author

@tolusha @olexii4 Please review and let me know if you have questions.
No rush!

…rms)

Co-authored-by: Cursor <cursoragent@cursor.com>
@gtrivedi88 gtrivedi88 force-pushed the jtbd-configure-category branch from e7253c6 to a89a236 Compare June 26, 2026 14:27
gtrivedi88 and others added 3 commits June 26, 2026 19:58
… pre-existing Vale errors

The page-aliases on the target page already handle the old
administration-guide: xref via Antora redirects. No xref change
needed in the source file, avoiding pre-existing Vale errors.

Co-authored-by: Cursor <cursoragent@cursor.com>
The @antora/pdf-extension cannot generate discover.pdf when the nav
contains cross-module xrefs (overview:, hosted-che:). These entries
point to pages in other modules and break the PDF assembler.

Remove overview:introduction and hosted-che from Discover nav. These
pages are accessible from their own modules and the site start_page.

Co-authored-by: Cursor <cursoragent@cursor.com>
From downstream 13-point audit (DS 3.29, Jun 29):
- Replace "seamless" with "uninterrupted" (autoscaling)
- Replace "leverage" with "use" (user namespace, container run)
- Replace "robust" with "reliable"/"production-grade" (storage)
- Replace em dashes with colons in branding image list
- Zero fluff, zero em dashes, zero conscious language violations

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

@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.

This PR is huge, I propose to apply it in the next release 1.121.0 / 3.30.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants