Skip to content

fix: JTBD audit Get Started module#3160

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

fix: JTBD audit Get Started module#3160
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:jtbd-audit-get-started

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

Summary

  • Remove generic persona snippets from all 6 Get Started pages (guide-level callout sufficient per JTBD checklist)
  • Apply cloud development environment (CDE) terminology standard: lowercase in body text, "workspace" only for UI labels
  • Sync page content from downstream CQA-compliant source (tables, abstracts, prerequisites, verification sections)
  • Fix :description: attributes, {platforms-name} bug, DITA compliance ([role="_additional-resources"]), meta-commentary abstract

Changes

File Changes
your-first-workspace.adoc Sync abstract, fix {platforms-name} to {orch-name}, move link from NOTE to Additional resources, CDE terminology
starting-a-workspace-from-a-git-repository-url.adoc Replace example blocks with tables per Git provider, add .Verification, consolidate prerequisites, restore dashboard TIP
basic-actions-you-can-perform-on-a-workspace.adoc Sync abstract, fix description, CDE terminology in table actions
authenticating-to-a-git-server-from-a-workspace.adoc Add abstract, fix meta-commentary, sync body, add role annotation
using-a-git-provider-access-token.adoc Streamline steps, use {orch-cli} consistently, add PAT provider links to prerequisites, actionable verification
starting-a-workspace-from-a-raw-devfile-url.adoc Add abstract, move IMPORTANT to prerequisite, fix verification structure, restore dashboard TIP
snip_persona-developer.adoc Deleted (no longer referenced)

Zero content loss

All URL patterns (GitHub, GitLab, Bitbucket, Azure), code blocks, procedure steps, page-aliases, keywords, and technical details preserved. Upstream-only content retained (community section, kubectl reference, self-signed certificates xref).

Test plan

  • Antora build passes with --log-failure-level=error
  • Vale reports 0 errors on changed files
  • detect-unused-content.sh passes
  • Nav sidebar text matches page titles

Made with Cursor

@gtrivedi88 gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners July 10, 2026 16:46
@gtrivedi88 gtrivedi88 requested a review from l0rd July 10, 2026 16:46
@github-actions

github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown

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

@github-actions

github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

@gtrivedi88 gtrivedi88 force-pushed the jtbd-audit-get-started branch from a00678d to 4b92b62 Compare July 10, 2026 16:55
@gtrivedi88 gtrivedi88 changed the title fix: JTBD audit Get Started module -- CDE terminology, sync to downstream CQA fix: JTBD audit Get Started module Jul 10, 2026
@gtrivedi88 gtrivedi88 force-pushed the jtbd-audit-get-started branch from 4b92b62 to 5bffe49 Compare July 10, 2026 17:47
…ream CQA

- Remove generic persona snippets from all 6 pages (guide-level callout
  in master.adoc is sufficient per JTBD checklist)
- Delete partials/snip_persona-developer.adoc (no longer referenced)
- Apply cloud development environment (CDE) terminology standard:
  lowercase "cloud development environment" in body text, "workspace"
  only for UI labels (*Create Workspace*, *Workspaces* page)
- Sync page content from downstream CQA-compliant source:
  - starting-a-workspace-from-a-git-repository-url: replace example
    blocks with tables per Git provider, add .Verification, consolidate
    prerequisites
  - using-a-git-provider-access-token: streamline procedure steps, use
    {orch-cli} consistently (remove hardcoded oc TIP blocks), add PAT
    provider links to prerequisites, add actionable verification
  - starting-a-workspace-from-a-raw-devfile-url: add WHAT+WHY abstract,
    move devfile IMPORTANT to prerequisite, fix .Verification structure
- Fix :description: attributes to match = Title (5 pages had gerunds)
- Fix {platforms-name} -> {orch-name} in your-first-workspace.adoc
- Move inline xref from NOTE to Additional resources (DITA compliance)
- Add [role="_additional-resources"] annotations (DITA compliance)
- Restore dashboard TIPs to git-repo-url and raw-devfile procedures
- Fix meta-commentary abstract in authenticating-to-a-git-server
- Replace pass:[<!-- vale -->] HTML comments with AsciiDoc // comments
- Preserve upstream-only content: community section, page-aliases,
  keywords, self-signed certificates xref, kubectl reference

Zero content loss: all URL patterns, code blocks, procedure steps, and
technical details preserved. Upstream-only content retained.

Co-authored-by: Cursor <cursoragent@cursor.com>
@gtrivedi88 gtrivedi88 force-pushed the jtbd-audit-get-started branch from 5bffe49 to b3ba658 Compare July 10, 2026 17:55
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