Skip to content

Commit

Permalink
Add some SSH notes
Browse files Browse the repository at this point in the history
  • Loading branch information
vinokurig committed Aug 11, 2023
1 parent baf5855 commit 21acb57
Showing 1 changed file with 9 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,15 @@ Working with {prod-short} in your browser involves multiple URLs:
* [.underline]#The URLs for starting a new workspace#
* The URLs of your workspaces in use

With {prod-short}, you can visit a URL in your browser to start a new workspace that contains a clone of a Git repository. This way, you can clone a Git repository that is hosted on GitHub, a GitLab instance, or a Bitbucket server.
With {prod-short}, you can visit a URL in your browser to start a new workspace that contains a clone of a Git repository. You can use either an HTTPS or SSH URL to start a new workspace with a clone of a Git repository.

[IMPORTANT]
====
//TODO: point to the dashboard SSH procedure when https://github.com/eclipse/che/issues/22111 is done.
* If an SSH URl is used to start a new workspace, the SSH key must be propagated, see link:https://github.com/devfile/devworkspace-operator/blob/main/docs/additional-configuration.adoc#configuring-devworkspaces-to-use-ssh-keys-for-git-operations[Configuring DevWorkspaces to use SSH keys for Git operations].

Check warning on line 22 in modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc#L22

[RedHat.Spelling] Use correct American English spelling. Did you really mean 'URl'?
Raw output
{"message": "[RedHat.Spelling] Use correct American English spelling. Did you really mean 'URl'?", "location": {"path": "modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc", "range": {"start": {"line": 22, "column": 13}}}, "severity": "WARNING"}
* If the SSH URL points to a private repository, in order to be able to fetch the `devfile.yaml` content, an access token must be applied by the xref:configuring-oauth-for-git-providers.adoc[OAuth] or xref:using-a-git-provider-access-token.adoc[Personal Access Token] procedures.

Check failure on line 23 in modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc#L23

[RedHat.TermsErrors] Use 'to' rather than 'in order to'.
Raw output
{"message": "[RedHat.TermsErrors] Use 'to' rather than 'in order to'.", "location": {"path": "modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc", "range": {"start": {"line": 23, "column": 50}}}, "severity": "ERROR"}
====

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 Git repository to start a new workspace.

Expand Down

0 comments on commit 21acb57

Please sign in to comment.