Skip to content

Commit 13a5d67

Browse files
vinokurigmax-cxdeerskindoll
committed
Add info about starting a workspace from raw devfile location (#2566)
Co-authored-by: Max Leonov <mleonov@redhat.com> Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com>
1 parent 533deb8 commit 13a5d67

3 files changed

Lines changed: 98 additions & 0 deletions

File tree

‎modules/end-user-guide/nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
** xref:benefits-of-pull-requests-review-in-che.adoc[]
88
* xref:user-onboarding.adoc[]
99
** xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[]
10+
** xref:starting-a-new-workspace-from-a-devfile-url.adoc[]
1011
** xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]
1112
*** xref:url-parameter-concatenation.adoc[]
1213
*** xref:url-parameter-for-the-workspace-ide.adoc[]

‎modules/end-user-guide/pages/starting-a-new-workspace-from-a-devfile-url.adoc‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
:_content-type: PROCEDURE
2+
:description: Starting a new workspace from a devfile URL
3+
:keywords: start-new-workspace, start-a-new-workspace, how-to-start-new-workspace, how-to-start-a-new-workspace, starting-a-new-workspace, how-to-start-workspace, how-to-start-a-workspace
4+
:navtitle: Starting a new workspace from a devfile URL
5+
:page-aliases:
6+
7+
[id="starting-a-new-workspace-from-a-devfile-url"]
8+
= Starting a new workspace from a devfile URL
9+
10+
Working with {prod-short} in your browser involves multiple URLs:
11+
12+
* The URL of your organization's {prod-short} instance, used as part of all the following URLs
13+
* The URL of the *devfile*
14+
* [.underline]#The URLs for starting a new workspace#
15+
* The URLs of your workspaces in use
16+
17+
With {prod-short}, you can open a *devfile* URL in your browser to start a new workspace.
18+
19+
pass:[<!-- vale RedHat.Spelling = NO -->]
20+
21+
TIP: You can also use the *Git Repo URL ** field on the *Create Workspace* page of your {prod-short} dashboard to enter the URL of a *devfile* to start a new workspace.
22+
23+
pass:[<!-- vale RedHat.Spelling = YES -->]
24+
25+
.Prerequisites
26+
27+
* Your organization has a running instance of {prod-short}.
28+
* You know the FQDN URL of your organization's {prod-short} instance: `pass:c,a,q[{prod-url}]`.
29+
30+
.Procedure
31+
32+
To start a new workspace from a devfile URL:
33+
34+
. Optional: Visit your {prod-short} dashboard pages to authenticate to your organization's instance of {prod-short}.
35+
36+
. Visit the URL to start a new workspace using the basic syntax:
37+
[source,subs="+quotes,+attributes,+macros"]
38+
+
39+
----
40+
pass:c,a,q[{prod-url}]#__<devfile_url>__
41+
----
42+
+
43+
[TIP]
44+
====
45+
You can extend this URL with optional parameters:
46+
[source,subs="+quotes,+attributes,+macros"]
47+
----
48+
pass:c,a,q[{prod-url}]#__<devfile_url>__?__<optional_parameters>__ <1>
49+
----
50+
<1> See xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[].
51+
====
52+
+
53+
.A URL for starting a new workspace
54+
====
55+
56+
`pass:c,a,q[{prod-url}#https://github.com/che-samples/cpp-hello-world/main/devfile.yaml]`
57+
58+
====
59+
+
60+
[TIP]
61+
====
62+
You can pass your Personal Access Token to the URL to have access to private repositories:
63+
[source,subs="+quotes,+attributes,+macros"]
64+
----
65+
pass:c,a,q[{prod-url}]#__https://__<token>__@__<host>__/__<path> <1>
66+
----
67+
<1> Your Personal Access Token that you generated on the Git provider's website.
68+
69+
This works for GitHub, GitLab, Bitbucket, Microsoft Azure, and other providers that support Personal Access Token.
70+
====
71+
+
72+
.Verification
73+
74+
After you enter the URL to start a new workspace in a browser tab, it renders the workspace-starting page. When the new workspace is ready, the workspace IDE loads in the browser tab.
75+
76+
The workspace has a unique URL: `pass:c,a,q[{prod-url}]#workspace__<unique_url>__`.
77+
78+
[TIP]
79+
====
80+
You can not bookmark a URL for starting a new workspace in the address bar, but you can create the bookmark by using the browser bookmark manager instead:
81+
82+
* In Mozilla Firefox, go to *☰* *>* *Bookmarks* *>* *Manage bookmarks Ctrl+Shift+O* *>* *Bookmarks Toolbar* *>* *Organize* *>* *Add bookmark*.
83+
84+
* In Google Chrome, go to *⋮* *>* *Bookmarks* *>* *Bookmark manager* *>* *Bookmarks bar* *>* *⋮* *>* *Add new bookmark*.
85+
====
86+
[IMPORTANT]
87+
====
88+
To initiate a clone of the Git repository in the filesystem of the new workspace, the devfile must contain project info.
89+
90+
See https://devfile.io/docs/2.2.0/adding-projects.
91+
====
92+
93+
.Additional resources
94+
95+
* xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]
96+
* xref:basic-actions-you-can-perform-on-a-workspace.adoc[]

‎modules/end-user-guide/pages/user-onboarding.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
If your organization is already running a {prod-short} instance, you can get started as a new user by learning how to start a new workspace, manage your workspaces, and authenticate yourself to a Git server from a workspace:
1111

1212
. xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[]
13+
. xref:starting-a-new-workspace-from-a-devfile-url.adoc[]
1314
. xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]
1415
. xref:basic-actions-you-can-perform-on-a-workspace.adoc[]
1516
. xref:authenticating-to-a-git-server-from-a-workspace.adoc[]

0 commit comments

Comments
 (0)