-
Notifications
You must be signed in to change notification settings - Fork 175
chore: promote Get Started to top-level Antora module (JTBD Phase 2) #3136
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
gtrivedi88
wants to merge
16
commits into
eclipse-che:main
Choose a base branch
from
gtrivedi88:jtbd-get-started-category
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
f37135b
chore: promote Get Started to top-level Antora module (JTBD Phase 2)
gtrivedi88 fb81284
fix: use {orch-namespace} attribute and remove unused landing page
gtrivedi88 52166c5
fix: remove unused legacy landing page (replaced by your-first-worksp…
gtrivedi88 34b51ed
fix: add cross-module xref prefixes for end-user-guide pages
gtrivedi88 cd16006
fix: add cross-module xref prefixes for end-user-guide pages
gtrivedi88 adcccb4
fix: add cross-module xref prefix for mounting-git-configuration
gtrivedi88 2eb8d0b
fix: accept SME feedback — use 'Cloud Development Environment' in title
gtrivedi88 4f5121a
fix: revert to accurate title per SME feedback — raw devfile URL spec…
gtrivedi88 3af752b
feat: add developer persona callouts to Get Started module
gtrivedi88 4a3b447
refactor: use Antora partials for persona callouts in Get Started
gtrivedi88 53f641a
fix: use local get-started partial instead of cross-module discover:p…
gtrivedi88 31f0c02
fix: sync navtitle attributes with JTBD page titles in Get Started
gtrivedi88 7c9b536
fix: address SME feedback — cross-link to Kubernetes workspace manage…
gtrivedi88 7a6fc23
fix: change TIP to NOTE for workspace K8s object context
gtrivedi88 0b10aa0
fix: standardize terminology — CDE defined once, workspace throughout
gtrivedi88 377d0f8
fix: use Cloud Development Environment consistently in Get Started
gtrivedi88 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
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
18 changes: 0 additions & 18 deletions
18
modules/end-user-guide/pages/getting-started-with-che.adoc
This file was deleted.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| .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[] | ||
| * xref:authenticating-to-a-git-server-from-a-workspace.adoc[] | ||
| ** xref:using-a-git-provider-access-token.adoc[] | ||
| * xref:starting-a-workspace-from-a-raw-devfile-url.adoc[] | ||
8 changes: 5 additions & 3 deletions
8
...ing-to-a-git-server-from-a-workspace.adoc → ...ing-to-a-git-server-from-a-workspace.adoc
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| :_content-type: CONCEPT | ||
| :description: Go from opening the {prod-short} URL to coding in about three minutes. | ||
| :keywords: getting started, first workspace, onboarding | ||
| :navtitle: Your first-day experience | ||
|
|
||
| [id="your-first-workspace"] | ||
| = Your first-day experience | ||
|
|
||
| [role="_abstract"] | ||
| {prod-short} creates a Cloud Development Environment (CDE) for your project. The dashboard and CLI refer to each CDE as a *workspace*. Each Cloud Development Environment runs as a {orch-name} `DevWorkspace` custom resource on your cluster. You go from login to coding in about three minutes. | ||
|
|
||
| include::partial$snip_persona-developer.adoc[] | ||
|
|
||
| == From URL to code in four steps | ||
|
|
||
| When your administrator shares the {prod-short} dashboard URL, you go from login to coding in four steps: | ||
|
|
||
| . *Authenticate* -- {prod-short} redirects you to the login page. Enter your credentials and authorize {prod-short} to access your account. | ||
|
|
||
| . *Create Workspace page* -- After authentication, you land on the Create Workspace page. The page has two main sections: | ||
| + | ||
| ** *Git Repo URL* -- A field where you paste the HTTPS or SSH URL of your Git repository. | ||
| ** *Select a Sample* -- Pre-configured workspace samples for languages and frameworks such as Java, Node.js, Python, and Go. Use these to explore {prod-short} without connecting your own repository. | ||
|
|
||
| . *Start your workspace* -- When you enter a Git URL and click *Create & Open*, {prod-short} asks you to confirm that you trust the repository authors, then provisions the workspace. | ||
|
|
||
| . *IDE loads in your browser* -- The default IDE, Microsoft Visual Studio Code - Open Source, opens in your browser tab with the repository already cloned. | ||
|
|
||
| == Why does the first start take longer? | ||
|
|
||
| The first workspace start takes approximately 2-3 minutes because {prod-short} pulls container images to the cluster node. The workspace starting page displays real-time progress, including: | ||
|
|
||
| * Volume provisioning for persistent storage | ||
| * Container image pulls for the development tools and IDE | ||
| * Initialization of the project clone, home directory, and IDE server | ||
|
|
||
| Subsequent starts are faster because {platforms-name} caches the container images on the node. If your administrator has deployed the {image-puller-name-short}, images are pre-cached across all nodes for near-instant starts. | ||
|
|
||
| == What can you do in a Cloud Development Environment? | ||
|
|
||
| A running {prod-short} workspace provides: | ||
|
|
||
| Terminal:: A `bash` terminal in the IDE with your project directory as the working directory. The terminal prompt shows the current Git branch. | ||
|
|
||
| Git integration:: Your repository is cloned into the workspace filesystem. If your administrator has configured OAuth for your Git provider, you can push commits without re-entering credentials. | ||
|
|
||
| Development tools:: The Universal Developer Image (UDI) includes compilers, runtimes, and build tools for common languages. Your project's `devfile.yaml` can define additional tools and commands. | ||
|
|
||
| Workspace URL:: Each workspace has a unique URL in the format `pass:c,a,q[{prod-url}]/__<user_name>__/__<workspace_name>__/`. Bookmark this URL to return to a running workspace. | ||
|
|
||
| == Something went wrong? | ||
|
|
||
| Workspace fails to start with `OOMKilled` or `FailedScheduling`:: | ||
| Your {orch-namespace} exceeded its resource quota, or the workspace requested more memory or CPU than the cluster allows. Contact your administrator to adjust resource limits. | ||
|
|
||
| Git push returns `401 Unauthorized` or `403 Forbidden`:: | ||
| OAuth is not configured for your Git provider, or your token has expired. Configure authentication to resolve this issue. | ||
|
|
||
| Blank IDE with a `Could not register service workers` error:: | ||
| This error occurs in Google Chrome Incognito mode or Mozilla Firefox Private Browsing mode. Use a regular browser window instead. | ||
|
|
||
| .Additional resources | ||
|
|
||
| * xref:authenticating-to-a-git-server-from-a-workspace.adoc[] | ||
|
|
||
| == Joining the community | ||
|
|
||
| Public chat:: | ||
| Join the public link:https://communityinviter.com/apps/ecd-tools/join-the-community[Eclipse Cloud Dev Tools Working Group on Slack] | ||
| and the link:https://ecd-tools.slack.com/archives/C05SD64M85R[#forum-che channel] | ||
| to chat with the developers. | ||
|
|
||
| GitHub project repositories:: | ||
| Report bugs, request features, and contribute in the main link:https://github.com/eclipse/che[{prod} repository]. | ||
|
|
||
| Community meetings:: | ||
| Join us in the link:https://github.com/eclipse/che/wiki/{prod-id}-community-meetings[{prod-short} community meeting], available on-demand. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| This page is for developers who create and use cloud development environments. To learn more about common roles and example tasks referenced in {prod-short} documentation, see xref:discover:roles-and-tasks.adoc[]. |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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