Skip to content

chore: promote Develop to top-level Antora module (JTBD Phase 3) - #3153

Open
gtrivedi88 wants to merge 2 commits into
eclipse-che:mainfrom
gtrivedi88:jtbd-develop-category
Open

gtrivedi88 wants to merge 2 commits into
eclipse-che:mainfrom
gtrivedi88:jtbd-develop-category

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

What does this pull request change?

Creates a new top-level modules/develop/ Antora module by extracting all developer workflow content from end-user-guide.

40 pages, 12 partials, 6 examples, 19 images moved.

Nav structure

  • Credentials and configurations (secrets, ConfigMaps, SSH, Git)
  • Container tooling (fuse-overlayfs, kubedock)
  • Team workflow (PR review, GitHub Actions, factory badges)
  • Persistent storage and backups
  • Prevent workspace idling
  • URL parameter reference (13 reference pages)
  • IDE selection (VS Code, JetBrains, common IDE)
  • AI coding assistants
  • Devfiles and workspace customization

Changes

  • End-user-guide slimmed to troubleshooting only
  • page-aliases added for all 40 moved pages
  • antora.yml updated with develop nav

Pull Request checklist

  • No procedure changes — moves only
  • All pages contain :page-aliases: for backward-compatible URLs
  • Zero content loss

Made with Cursor

@gtrivedi88
gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners July 6, 2026 05:36
@gtrivedi88
gtrivedi88 requested a review from l0rd July 6, 2026 05:36
@github-actions

github-actions Bot commented Jul 6, 2026 •

Copy link
Copy Markdown

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

@github-actions

github-actions Bot commented Jul 6, 2026 •

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

@gtrivedi88
gtrivedi88 force-pushed the jtbd-develop-category branch 10 times, most recently from f3d4e75 to a589c66 Compare July 13, 2026 05:55
@gtrivedi88
gtrivedi88 force-pushed the jtbd-develop-category branch 4 times, most recently from ab8c408 to 9d1e78d Compare July 15, 2026 10:43
@gtrivedi88
gtrivedi88 force-pushed the jtbd-develop-category branch 2 times, most recently from d96e485 to 1f4698b Compare August 24, 2026 14:28
@gtrivedi88
gtrivedi88 force-pushed the jtbd-develop-category branch 2 times, most recently from e2de2ee to 8a09f35 Compare September 16, 2026 14:22
Move developer-facing content from end-user-guide to a new top-level
modules/develop/ Antora module. Apply JTBD titles, CQA formatting,
and zero-content-loss restructuring for Claude Code persistence files.

Co-authored-by: Cursor <cursoragent@cursor.com>
@gtrivedi88
gtrivedi88 force-pushed the jtbd-develop-category branch from 8a09f35 to 065aa2c Compare September 16, 2026 14:36
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>
@gtrivedi88
gtrivedi88 force-pushed the jtbd-develop-category branch from cd1d354 to d605cc3 Compare September 17, 2026 06:24
gtrivedi88 added a commit that referenced this pull request Sep 23, 2026
The dawidd6/action-download-artifact step in this workflow only
specified 'workflow', not 'run_id'. Without run_id, the action
searches for the most recent successful 'doc-content' artifact for
that workflow name across the entire repository instead of the
specific run that triggered this workflow_run event.

allow_forks defaults to false, which additionally causes the search
to skip fork-originated PR runs (every JTBD PR is opened from a
fork). The net effect: preview links for fork PRs get attributed to
whatever non-fork branch happens to have the most recent successful
build, instead of the PR that actually triggered the workflow.

Observed on PR #3143: multiple concurrently-building fork PRs
(#3143, #3151, #3153, #3155) never received their own preview link;
the '"Navigate the preview"' comment kept landing on PR #3192
(a same-repo branch push) instead, whose sticky comment was
repeatedly overwritten with unrelated deploy links throughout the
day (createdAt stayed 2026-09-09 while the body kept changing).

Fix: pin run_id to github.event.workflow_run.id so the artifact
download always resolves to the exact run that completed, and set
allow_forks: true since this workflow already executes in the base
repo's trusted context via workflow_run.

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

@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


.Procedure

. Install version {copilot-ext-ver} of the *Dev Spaces Copilot Chat Integration* extension.

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.

@RomanNikitenko @rgrunber do we need this doc in main?

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.

I don't think we need it, Copilot already built into the editor

:description: You can enable fuse-overlayfs storage driver for Podman
:keywords: overlay, configmap, podman, storage, driver, fuse-overlayfs
:navtitle: Enabling fuse-overlayfs with a ConfigMap
:navtitle: Enabling fuse-overlayfs with a Configmap

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.

since it's k8s resource name, I think it should be ConfigMap

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.

@gtrivedi88 WDYT?

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