Skip to content

chore: promote Extend to top-level Antora module (JTBD Phase 3)#3143

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

chore: promote Extend to top-level Antora module (JTBD Phase 3)#3143
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:jtbd-extend-category

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

What does this pull request change?

Creates a new top-level modules/extend/ Antora module by extracting IDE extension management, VS Code configuration, editor management, and AI provider registration from the Administration Guide.

21 pages, 3 partials, 5 examples moved from modules/administration-guide/ to modules/extend/.

Nav structure (user journey order)

  1. Choose which editors are available (5 pages) — add custom editors, set default, hide/restore, air-gapped binaries
  2. Customize the default IDE (6 pages) — VS Code multi-root, trusted/default extensions, editor ConfigMaps
  3. Manage IDE extensions (2 pages + 3 partials) — Open VSX registry concepts, add/remove extensions
  4. Deploy a private extension registry (6 pages) — deploy from image/source/workspace, internal access, extension deletion
  5. Register AI coding assistants (2 pages) — AI providers, API key secret reference

Changes to administration-guide

  • Removed IDE extensions, VS Code, and AI sections from nav
  • Slimmed Dashboard section (removed 5 editor pages, kept samples + branding)
  • Updated cross-module xrefs to extend: prefix

Cross-module xref updates

  • admin-guide dashboard → extend: for 3 editor refs
  • end-user-guide → extend: for 2 extension refs
  • checluster-custom-resource-fields-reference → extend: for AI ref
  • extend pages → administration-guide: for CheCluster config refs

Backward compatibility

Added :page-aliases: administration-guide:<page> to all 21 moved pages for URL redirects.

What issues does this pull request fix or reference?

Part of JTBD Phase 3 restructuring.

Specify the version of the product this pull request applies to

next

Pull Request checklist

  • Any procedure:
    • No procedure changes — moves only.
  • Any page or link rename:
    • All pages contain :page-aliases: redirections for previous URLs.
  • the Validate language on files added or modified step reports no vale warnings.

Made with Cursor

@gtrivedi88 gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners July 3, 2026 07:24
@gtrivedi88 gtrivedi88 requested a review from amisevsk July 3, 2026 07:24
@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://6a4c80598c4c789b4eeaee78--eclipse-che-docs-pr.netlify.app 🎊

@gtrivedi88 gtrivedi88 force-pushed the jtbd-extend-category branch 4 times, most recently from 05b1fc7 to 87d76ee Compare July 7, 2026 03:41
Create modules/extend/ with 21 pages, 4 partials, 5 examples, and
nav.adoc. Move IDE extension management, editor configuration, private
registry deployment, and AI provider registration content from
administration-guide into the new Extend module.

JTBD compliance:
- Imperative procedure titles matching user goals
- WHAT+WHY abstracts with title-verb consistency
- Admin prerequisites on all procedures
- [role="_abstract"] and [role="_additional-resources"] annotations
- .Next steps converted to .Additional resources (DITA)
- No generic persona snippets in topic files
- Content body synced with downstream CQA source of truth

Co-authored-by: Cursor <cursoragent@cursor.com>
@gtrivedi88 gtrivedi88 force-pushed the jtbd-extend-category branch from 87d76ee to 2dddc9c Compare July 7, 2026 03:56
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