From eb3bdc505f1c70df443e6caa3728849b53f315ab Mon Sep 17 00:00:00 2001 From: Igor Vinokur Date: Fri, 11 Aug 2023 14:42:04 +0300 Subject: [PATCH 1/6] Add some SSH notes --- ...new-workspace-with-a-clone-of-a-git-repository.adoc | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc b/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc index 19022f3902..7009f85de9 100644 --- a/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc +++ b/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc @@ -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]. +* If the SSH URL points to a private repository, to be able to fetch the `devfile.yaml` content, an access token must be applied by accepting an SCM authentication page or xref:using-a-git-provider-access-token.adoc[Personal Access Token] procedures. + +==== 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. From 106bef2a96cf28cf85546bdbf7cfe9d8c5e28c2d Mon Sep 17 00:00:00 2001 From: Igor Vinokur Date: Wed, 23 Aug 2023 15:55:00 +0300 Subject: [PATCH 2/6] Update modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc Co-authored-by: Jana Vrbkova --- ...arting-a-new-workspace-with-a-clone-of-a-git-repository.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc b/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc index 7009f85de9..a272d9c7af 100644 --- a/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc +++ b/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc @@ -14,7 +14,7 @@ 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. You can use either an HTTPS or SSH URL to start a new workspace with a clone of a Git repository. +With {prod-short}, you can use either an HTTPS or SSH URL to start a new workspace with a clone of a Git repository. [IMPORTANT] ==== From 800d2ded6b63ccacc818ab8215a2688c0bb99b3d Mon Sep 17 00:00:00 2001 From: Igor Vinokur Date: Wed, 23 Aug 2023 15:56:02 +0300 Subject: [PATCH 3/6] Update modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc Co-authored-by: Jana Vrbkova --- ...arting-a-new-workspace-with-a-clone-of-a-git-repository.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc b/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc index a272d9c7af..eed728a8f6 100644 --- a/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc +++ b/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc @@ -20,7 +20,7 @@ With {prod-short}, you can use either an HTTPS or SSH URL to start a new workspa ==== //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]. -* If the SSH URL points to a private repository, to be able to fetch the `devfile.yaml` content, an access token must be applied by accepting an SCM authentication page or xref:using-a-git-provider-access-token.adoc[Personal Access Token] procedures. +* If the SSH URL points to a private repository, you must apply an access token to be able to fetch the `devfile.yaml` content. You can do this either by accepting an SCM authentication page or following a xref:using-a-git-provider-access-token.adoc[Personal Access Token] procedure. ==== From a2c2536152ffd23b9a507219a065179ac6ac03d9 Mon Sep 17 00:00:00 2001 From: Igor Vinokur Date: Wed, 23 Aug 2023 15:57:46 +0300 Subject: [PATCH 4/6] Update modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc Co-authored-by: Jana Vrbkova --- ...arting-a-new-workspace-with-a-clone-of-a-git-repository.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc b/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc index eed728a8f6..fe686474b6 100644 --- a/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc +++ b/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc @@ -19,7 +19,7 @@ With {prod-short}, you can use either an HTTPS or SSH URL to start a new workspa [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]. +* If you use a SSH URL to start a new workspace, you must propagate 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] for more information. * If the SSH URL points to a private repository, you must apply an access token to be able to fetch the `devfile.yaml` content. You can do this either by accepting an SCM authentication page or following a xref:using-a-git-provider-access-token.adoc[Personal Access Token] procedure. ==== From e786f646a275c8528b2761d3caebd3bc3346d30c Mon Sep 17 00:00:00 2001 From: Igor Vinokur Date: Wed, 23 Aug 2023 15:59:05 +0300 Subject: [PATCH 5/6] fixup! Add some SSH notes --- ...arting-a-new-workspace-with-a-clone-of-a-git-repository.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc b/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc index fe686474b6..939bef5f76 100644 --- a/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc +++ b/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc @@ -19,7 +19,7 @@ With {prod-short}, you can use either an HTTPS or SSH URL to start a new workspa [IMPORTANT] ==== //TODO: point to the dashboard SSH procedure when https://github.com/eclipse/che/issues/22111 is done. -* If you use a SSH URL to start a new workspace, you must propagate 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] for more information. +* If you use an SSH URL to start a new workspace, you must propagate 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] for more information. * If the SSH URL points to a private repository, you must apply an access token to be able to fetch the `devfile.yaml` content. You can do this either by accepting an SCM authentication page or following a xref:using-a-git-provider-access-token.adoc[Personal Access Token] procedure. ==== From b0f7957c91ee0d9931206e1c7b6a3292fd860a88 Mon Sep 17 00:00:00 2001 From: Igor Vinokur Date: Wed, 23 Aug 2023 16:00:25 +0300 Subject: [PATCH 6/6] fixup! Add some SSH notes --- ...arting-a-new-workspace-with-a-clone-of-a-git-repository.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc b/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc index 939bef5f76..b42c32c008 100644 --- a/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc +++ b/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc @@ -19,7 +19,7 @@ With {prod-short}, you can use either an HTTPS or SSH URL to start a new workspa [IMPORTANT] ==== //TODO: point to the dashboard SSH procedure when https://github.com/eclipse/che/issues/22111 is done. -* If you use an SSH URL to start a new workspace, you must propagate 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] for more information. +* If you use an SSH URL to start a new workspace, you must propagate the SSH key. 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] for more information. * If the SSH URL points to a private repository, you must apply an access token to be able to fetch the `devfile.yaml` content. You can do this either by accepting an SCM authentication page or following a xref:using-a-git-provider-access-token.adoc[Personal Access Token] procedure. ====