chore: promote Get Started to top-level Antora module (JTBD Phase 2)#3136
Open
gtrivedi88 wants to merge 16 commits into
Open
chore: promote Get Started to top-level Antora module (JTBD Phase 2)#3136gtrivedi88 wants to merge 16 commits into
gtrivedi88 wants to merge 16 commits into
Conversation
gtrivedi88
requested review from
a team,
deerskindoll and
mkuznyetsov
as code owners
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
|
🎊 Navigate the preview: https://6a47b21e07333128bd5163c6--eclipse-che-docs-pr.netlify.app 🎊 |
ibuziuk
reviewed
Jul 2, 2026
ibuziuk
reviewed
Jul 2, 2026
gtrivedi88
force-pushed
the
jtbd-get-started-category
branch
from
572d9e5 to
82f631d
Compare
ibuziuk
reviewed
Jul 3, 2026
| .Get Started | ||
| * xref:your-first-workspace.adoc[] | ||
| * xref:starting-a-workspace-from-a-git-repository-url.adoc[] | ||
| * xref:basic-actions-you-can-perform-on-a-workspace.adoc[] |
Member
There was a problem hiding this comment.
this section should be cross-linked with https://6a479f877b6b963b51397db5--eclipse-che-docs-pr.netlify.app/docs/next/end-user-guide/managing-workspaces-with-apis/
Basically, we should clarify that on the Kubernetes level, workspace CDE = k8s object
ibuziuk
reviewed
Jul 3, 2026
| | _Delete a workspace_ | ||
| | Go to *⋮* *>* *Delete Workspace*. | ||
|
|
||
| |=== |
Member
There was a problem hiding this comment.
We should clarify that CDE / workspace = k8s object and cross-link this section with https://6a479f877b6b963b51397db5--eclipse-che-docs-pr.netlify.app/docs/next/end-user-guide/managing-workspaces-with-apis/
Move getting-started content from User Guide into a new modules/get-started/ Antora module, following the CCS 'Get Started' category: 'Perform the simplest first tasks to become productive.' - Create modules/get-started/ with nav and 7 pages (6 moved + 1 new) - New page: your-first-workspace.adoc (first-day experience, adapted from downstream con_your-first-workspace.adoc with Che branding) - Move workspace creation, Git auth, PAT pages from end-user-guide - Add page-aliases for backward-compatible redirects - Apply JTBD titles from downstream audit - Update cross-module xrefs in install, hosted-che, end-user-guide - Slim end-user-guide nav (getting-started section removed) - Add modules/get-started/nav.adoc to antora.yml Mirrors downstream devspaces-documentation Get Started guide structure. Co-authored-by: Cursor <cursoragent@cursor.com>
- Per-page persona callout added to all 6 topic pages - Links to discover:roles-and-tasks.adoc for role definitions Co-authored-by: Cursor <cursoragent@cursor.com>
Replace hardcoded persona text with include::discover:partial$snip_persona-developer.adoc[] in all 6 get-started pages. Partials created in Discover PR eclipse-che#3131. Co-authored-by: Cursor <cursoragent@cursor.com>
…artial Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88
force-pushed
the
jtbd-get-started-category
branch
from
f5fd4fa to
67d899f
Compare
…ment Add TIP explaining that workspaces are DevWorkspace custom resources and linking to managing-workspaces-with-apis for CLI management. Requested by @ibuziuk in PR review. Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88
force-pushed
the
jtbd-get-started-category
branch
from
67d899f to
7c9b536
Compare
Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88
force-pushed
the
jtbd-get-started-category
branch
from
cd6c8f9 to
7a6fc23
Compare
- Add CDE=workspace=DevWorkspace equivalence to your-first-workspace overview - Change title from "Cloud Development Environment" to "cloud workspace" for consistency with rest of Get Started guide and UI terminology - After the first definition, "workspace" is used consistently Follows Google/Microsoft pattern: define the full term once, use the short product term throughout. Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88
force-pushed
the
jtbd-get-started-category
branch
from
6b44abc to
0b10aa0
Compare
CDE is the industry standard term. Use it in all titles and headings. "Workspace" only when quoting exact UI labels (Workspaces page, Create Workspace button). - Restore "Open your project in a Cloud Development Environment" (SME) - "How Git authentication works in Cloud Development Environments" - "Manage your Cloud Development Environments" - "Start a Cloud Development Environment from a raw devfile URL" - "What can you do in a Cloud Development Environment?" - Overview defines CDE = workspace = DevWorkspace equivalence Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88
force-pushed
the
jtbd-get-started-category
branch
from
5b648cc to
377d0f8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
modules/get-started/Changes
modules/get-started/with nav.adoc, 7 pages (6 moved + 1 new)your-first-workspace.adoc(first-day experience from URL to coding)antora.ymlwith get-started navTest plan
Made with Cursor