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

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

⚡️ Deploying pull request preview...

@gtrivedi88
gtrivedi88 force-pushed the jtbd-extend-category branch 11 times, most recently from 5442777 to 5a1fc79 Compare July 11, 2026 02:05
@gtrivedi88
gtrivedi88 force-pushed the jtbd-extend-category branch 5 times, most recently from 009793f to 9f620cd Compare July 15, 2026 14:13
@svor
svor self-requested a review July 27, 2026 15:38
@gtrivedi88
gtrivedi88 force-pushed the jtbd-extend-category branch 2 times, most recently from 005c05a to 860c861 Compare August 24, 2026 14:28

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

LGTM
@gtrivedi88 can you check failed PR checks please, I'd like to verify the preview as well

Move editor, extension, AI provider, and Open VSX content from
administration-guide to a new top-level modules/extend/ Antora module.
Apply JTBD titles, sync navtitles, and fix cross-module xrefs.

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

Copy link
Copy Markdown
Contributor Author

@svor Fixed the pipeline. Please review the output and let me know your suggestions.

@svor

svor commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

@gtrivedi88 I don't see the link to the Preview page, is it expected?

gtrivedi88 added a commit to gtrivedi88/che-docs that referenced this pull request Sep 17, 2026
PR eclipse-che#3097 (procedures: Document GitHub Copilot Chat usage,
RomanNikitenko, merged May 18) targeted the 7.117.x release branch
directly instead of main, so this content never reached main and was
absent from every JTBD category restructure, including this Develop
PR. Forward-porting it now (Job 27: "Use AI coding assistants in your
workspace").

- Add modules/develop/pages/using-github-copilot-chat.adoc, ported
  from 7.117.x with fixes:
  - Add missing [role="_abstract"] tag
  - Reword abstract to open with "Set up" to match the title verb
  - Convert 1 inline IMPORTANT: admonition to block-delimited format
  - Replace "Kubernetes object" with the {kubernetes} attribute
  - Fix RedHat.TermsWarnings/Using Vale warnings (may->might,
    appears->is displayed, using->by using)
- Nest it under microsoft-visual-studio-code-open-source-ide.adoc in
  modules/develop/nav.adoc, matching its original 7.117.x placement
- On microsoft-visual-studio-code-open-source-ide.adoc (CONCEPT):
  - Fix stale xref:administration-guide:extensions-for-microsoft-...
    -open-source-ide.adoc -- that page already moved to modules/extend/
    in PR eclipse-che#3143, so this was a broken cross-module reference
  - Move that link + the new Copilot Chat link out of body text into
    a proper [role="_additional-resources"] .Additional resources
    block (Parameter 2a), with a plain-text bridge sentence in the
    body pointing to it (Parameter 2b)

NOTE: :copilot-ext-ver: is still pinned to 0.36.2 from the 7.117.x
(DS 3.28 / Che 7.117) era. Needs SME confirmation that this version
is still current/compatible on 7.122.x before merge.

Vale: 0 errors on all 3 changed files. Remaining warnings are on
functional GitHub/Open VSX links and pre-existing URL paths.

Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88 added a commit to gtrivedi88/che-docs that referenced this pull request Sep 17, 2026
PR eclipse-che#3097 (procedures: Document GitHub Copilot Chat usage,
RomanNikitenko, merged May 18) targeted the 7.117.x release branch
directly instead of main, so this content never reached main and was
absent from every JTBD category restructure, including this Develop
PR. Forward-porting it now (Job 27: "Use AI coding assistants in your
workspace").

- Add modules/develop/pages/using-github-copilot-chat.adoc, ported
  from 7.117.x with fixes:
  - Add missing [role="_abstract"] tag
  - Reword abstract to open with "Set up" to match the title verb
  - Convert 1 inline IMPORTANT: admonition to block-delimited format
  - Replace "Kubernetes object" with the {kubernetes} attribute
  - Fix RedHat.TermsWarnings/Using Vale warnings (may->might,
    appears->is displayed, using->by using)
- Nest it under microsoft-visual-studio-code-open-source-ide.adoc in
  modules/develop/nav.adoc, matching its original 7.117.x placement
- On microsoft-visual-studio-code-open-source-ide.adoc (CONCEPT):
  move the pre-existing Open VSX registry link + the new Copilot Chat
  link out of body text into a proper
  [role="_additional-resources"] .Additional resources block
  (Parameter 2a), with a plain-text bridge sentence in the body
  pointing to it (Parameter 2b). Keep the existing
  xref:administration-guide:extensions-for-microsoft-visual-studio-...
  target as-is -- that page still lives at that path on main and in
  this branch; it only moves once PR eclipse-che#3143 (Extend) merges, at which
  point a follow-up xref fix (matching the eclipse-che#3178 precedent) will be
  needed after that merge, not before.

NOTE: :copilot-ext-ver: is still pinned to 0.36.2 from the 7.117.x
(DS 3.28 / Che 7.117) era. Needs SME confirmation that this version
is still current/compatible on 7.122.x before merge.

Vale: 0 errors on all 3 changed files. Remaining warnings are on
functional GitHub/Open VSX links and pre-existing URL paths.

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.

2 participants