Skip to content

Add info about starting a workspace from raw devfile location #2563

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.

Sign up for GitHub

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

Closed
vinokurig wants to merge 5 commits into from
Closed

Add info about starting a workspace from raw devfile location #2563

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
89e0600
Add info about starting a workspace from raw devfile location
vinokurig Feb 23, 2023
a91ed9c
fixup! Add info about starting a workspace from raw devfile location
vinokurig Feb 27, 2023
eb30879
Update modules/end-user-guide/pages/starting-a-new-workspace-with-a-c…
vinokurig Feb 28, 2023
93fb2b7
Update modules/end-user-guide/pages/starting-a-new-workspace-with-a-c…
vinokurig Feb 28, 2023
0e66f07
Update modules/end-user-guide/pages/starting-a-new-workspace-with-a-c…
vinokurig Feb 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions ...user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ To start a new workspace with a clone of a Git repository:
. Optional: Visit your {prod-short} dashboard pages to authenticate to your organization's instance of {prod-short}.

. Visit the URL to start a new workspace using the basic syntax:
.. Use a Git repository URL:
[source,subs="+quotes,+attributes,+macros"]
+
----
Expand Down Expand Up @@ -76,6 +77,32 @@ A clone of the Git repository is present in the filesystem of the new workspace.
+
The workspace has a unique URL: `pass:c,a,q[{prod-url}]#workspace__<unique_url>__`.

.. Use a direct URL to `devfile`:
[source,subs="+quotes,+attributes,+macros"]
+
----
pass:c,a,q[{prod-url}]#__<url_to_devfile>__
----
+
[TIP]
====
You can pass Personal Access Token to the URL to have access to private repositories:
Copy link
Member

@ibuziuk ibuziuk Feb 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we can add info that this would work for GitHub, GitLab, Bitbucket, Azure, and other types repositories that support this type of OAuth

Copy link
Contributor Author

@vinokurig vinokurig Feb 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

[source,subs="+quotes,+attributes,+macros"]
----
pass:c,a,q[{prod-url}]#__https://__<token>__@__<host>__/__<path> <1>
Copy link
Member

@ibuziuk ibuziuk Feb 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vinokurig probably here we need to add IMPORTANT: note that devfile should contain the project reference, also maybe worth mentioning that path = path to devfile

----
<1> See xref:using-a-git-provider-access-token.adoc[].

This works for GitHub, GitLab, Bitbucket, Microsoft Azure, and other providers that support Personal Access Token.
====
+
.A URL for starting a new workspace from devfile location
====

`pass:c,a,q[{prod-url}#https://github.com/che-samples/cpp-hello-world/main/devfile.yaml]`

====

[TIP]
====
Although this is not possible in the address bar, you can add a URL for starting a new workspace as a bookmark by using the browser bookmark manager:
Expand Down