Skip to content

chore: promote Get Started to top-level Antora module (JTBD Phase 2)#3136

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

chore: promote Get Started to top-level Antora module (JTBD Phase 2)#3136
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:jtbd-get-started-category

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

Summary

  • Promote getting-started content from User Guide into modules/get-started/
  • Follows CCS category definition: Get Started = 'Perform first tasks to become productive'
  • Mirrors downstream devspaces-documentation structure (shipped in DS 3.29)

Changes

  • New modules/get-started/ with nav.adoc, 7 pages (6 moved + 1 new)
  • New page: your-first-workspace.adoc (first-day experience from URL to coding)
  • Moved: workspace creation, Git auth, PAT, raw devfile, basic actions from end-user-guide
  • Updated antora.yml with get-started nav
  • Slimmed end-user-guide nav (getting-started section removed)
  • Cross-module xrefs updated in install, hosted-che, end-user-guide
  • page-aliases for backward-compatible URLs
  • JTBD titles applied (user goals, not feature names)

Test plan

  • Antora build succeeds
  • Old end-user-guide URLs redirect via page-aliases
  • Get Started nav renders correctly
  • No broken xrefs across modules

Made with Cursor

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>
@gtrivedi88 gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners June 29, 2026 14:30
@gtrivedi88 gtrivedi88 requested a review from nickboldt June 29, 2026 14:30
@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

@github-actions

Copy link
Copy Markdown

⚡️ Deploying pull request preview...

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