fix: JTBD audit Get Started module#3160
Open
gtrivedi88 wants to merge 1 commit into
Open
Conversation
gtrivedi88
requested review from
a team,
deerskindoll and
mkuznyetsov
as code owners
|
🎊 Navigate the preview: https://6a56375eda5f6c9ce9d4bb76--eclipse-che-docs-pr.netlify.app 🎊 |
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
gtrivedi88
force-pushed
the
jtbd-audit-get-started
branch
from
a00678d to
4b92b62
Compare
gtrivedi88
changed the title
gtrivedi88
force-pushed
the
jtbd-audit-get-started
branch
2 times, most recently
from
5bffe49 to
b3ba658
Compare
Split the single Get Started module into two separate Antora modules to match the downstream 2-book structure: - get-started-admin: New administrator onboarding guide (4 pages) adapted from downstream CQA-compliant source. Covers post-install verification, GitHub OAuth configuration, and next-steps reference. - get-started-user: Renamed from get-started. Developer guide with nav grouping into 2 sections matching downstream assemblies: "Start your first cloud development environment" (3 pages) and "Connect to your Git repositories" (2 pages). Content quality changes from the original PR preserved: - Remove generic persona snippets from all pages - 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 - Sync page content from downstream CQA-compliant source - Fix :description: attributes to match = Title - Move starting-a-workspace-from-a-raw-devfile-url to end-user-guide - Add [role="_additional-resources"] annotations (DITA compliance) Structural changes: - Create modules/get-started-admin/ with nav.adoc and 4 new pages - Rename modules/get-started/ to modules/get-started-user/ - Add :page-aliases: get-started:*.adoc on all user pages for URL backward compatibility - Update antora.yml: 2 nav entries replace single get-started entry - Update 5 cross-module xrefs from get-started: to get-started-user: (end-user-guide nav, hosted-che, install next-steps, raw-devfile) - Add xref to get-started-admin from install next-steps page Zero content loss: all URL patterns, code blocks, procedure steps, and technical details preserved. Upstream-only content retained (community section, kubectl reference, self-signed certificates xref). Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88
force-pushed
the
jtbd-audit-get-started
branch
from
b3ba658 to
c036370
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
1 participant
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
:description:attributes,{platforms-name}bug, DITA compliance ([role="_additional-resources"]), meta-commentary abstractChanges
your-first-workspace.adoc{platforms-name}to{orch-name}, move link from NOTE to Additional resources, CDE terminologystarting-a-workspace-from-a-git-repository-url.adoc.Verification, consolidate prerequisites, restore dashboard TIPbasic-actions-you-can-perform-on-a-workspace.adocauthenticating-to-a-git-server-from-a-workspace.adocusing-a-git-provider-access-token.adoc{orch-cli}consistently, add PAT provider links to prerequisites, actionable verificationstarting-a-workspace-from-a-raw-devfile-url.adocsnip_persona-developer.adocZero 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
--log-failure-level=errordetect-unused-content.shpassesMade with Cursor