Skip to content

chore: promote Integrate to top-level Antora module (JTBD Phase 3) - #3151

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

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

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

What does this pull request change?

Creates a new top-level modules/integrate/ Antora module by extracting OAuth for Git providers (from administration-guide) and OpenShift integration + artifact repositories (from end-user-guide).

19 pages, 24 partials, 4 images moved.

Nav structure (user journey order)

  1. Give developers credential-free Git access (7 pages) -- OAuth for GitHub, GitLab, Bitbucket, Azure DevOps
  2. Manage workspaces from the command line (1 page + 5 partials) -- oc/kubectl workspace management
  3. Use Kubernetes tools with workspaces (4 pages) -- token injection, Developer Perspective, console navigation
  4. Connect workspaces to your organization's package registries (7 pages) -- Maven, Gradle, npm, Python, Go, NuGet

JTBD title rework (all 19 pages)

  • "Configuring OAuth for Git providers" -> "Give developers credential-free Git access"
  • "Configuring OAuth 2.0 for GitHub" -> "Connect GitHub with OAuth"
  • "Integrating with Kubernetes" -> "Use Kubernetes tools with workspaces"
  • "Enabling artifact repositories" -> "Connect workspaces to your organization's package registries"
  • All navtitles synced with page titles

Cross-module xref updates

  • 5 files updated across discover, install, end-user-guide, admin-guide

Added :page-aliases: for all 19 moved pages.

Pull Request checklist

  • No procedure changes -- moves and title rework 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 3, 2026 12:22
@gtrivedi88
gtrivedi88 requested a review from nickboldt July 3, 2026 12:22
@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://6ab3dead39fc95ba3b339988--eclipse-che-docs-pr.netlify.app 🎊

@gtrivedi88
gtrivedi88 force-pushed the jtbd-integrate-category branch 4 times, most recently from 657d7dd to 2d4dd8f Compare July 7, 2026 05:03
@gtrivedi88
gtrivedi88 force-pushed the jtbd-integrate-category branch 5 times, most recently from f0daf41 to f0782b9 Compare July 15, 2026 14:05
@svor
svor self-requested a review July 27, 2026 15:39
@svor
svor requested a review from vinokurig August 12, 2026 10:33
@vinokurig

Copy link
Copy Markdown
Contributor

The authorization flow related changes looks good to me

@gtrivedi88
gtrivedi88 force-pushed the jtbd-integrate-category branch 2 times, most recently from 3cc34e7 to 9532639 Compare August 24, 2026 14:31
@gtrivedi88
gtrivedi88 force-pushed the jtbd-integrate-category branch from 9532639 to caff870 Compare September 16, 2026 14:01
Create modules/integrate/ with pages, partials, and images moved from
administration-guide (OAuth) and end-user-guide (OpenShift integration,
artifact repositories).

Nav structure (user journey order):
- Give developers credential-free Git access (7 pages, 12 partials)
- Manage workspaces from the command line (1 page, 5 partials)
- Use Kubernetes tools with workspaces (4 pages, 3 partials)
- Connect workspaces to your organization's package registries (7 pages, 3 partials)

JTBD title rework on all 19 pages:
- Configuring OAuth for Git providers -> Give developers credential-free Git access
- All "Configuring OAuth 2.0 for X" -> "Connect X with OAuth"
- Integrating with Kubernetes -> Use Kubernetes tools with workspaces
- Managing workspaces with APIs -> Manage workspaces from the command line
- Enabling artifact repositories -> Connect workspaces to your package registries
- All navtitles synced with page titles

Cross-module xref updates:
- 5 files updated: discover, install, end-user-guide, admin-guide

Added: page-aliases: for all 19 moved pages.
Co-authored-by: Cursor <cursoragent@cursor.com>
@gtrivedi88
gtrivedi88 force-pushed the jtbd-integrate-category branch from caff870 to 1a917b0 Compare September 16, 2026 14:18
PR eclipse-che#3168 (Device Auth Tokens, merged Sep 1) added a GitHub device
authorization procedure but landed it in the legacy end-user-guide
module instead of the new Integrate module created by this PR. This
left Job 32 ("Enable credential-free Git access for developers")
content orphaned outside the JTBD Integrate category.

- Move connecting-to-github-using-device-authorization.adoc from
  modules/end-user-guide/pages/ to modules/integrate/pages/
- Add it to modules/integrate/nav.adoc, remove from
  modules/end-user-guide/nav.adoc
- Fix gerund title/navtitle/subheadings to JTBD imperative form:
  "Connect to GitHub with device authorization", "Reconnect to
  GitHub", "Delete a device auth token", "Restart after an expired
  code"
- Convert 3 inline NOTE: admonitions to block-delimited format
- Update xref:administration-guide:/end-user-guide: cross-module
  references to same-module xrefs now that both pages live in
  modules/integrate/
- Fix related inline NOTE: in proc_setting-up-the-github-oauth-app.adoc
  (same feature) and its stale cross-module xref to the moved page
- Vale: 0 errors on all changed files (pre-existing GitHub-link and
  unrelated line warnings left untouched, out of scope for this fix)

Co-authored-by: Cursor <cursoragent@cursor.com>
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

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