Add some SSH notes #2639
Add some SSH notes #2639
Conversation
vinokurig
requested review from
rkratky,
max-cx,
deerskindoll and
a team
as code owners
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
|
🎊 Navigate the preview: https://64e747a904c0f37b1d94d063--eclipse-che-docs-pr.netlify.app 🎊 |
vinokurig
force-pushed
the
che-22354
branch
4 times, most recently
from
f83bf6d
to
8ca3467
Compare
modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc
Outdated
Show resolved
Hide resolved
| [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]. |
There was a problem hiding this comment.
This point should be stripped or reworked for downstreaming; I don't think we want to point to the upstream github repo for docs in downstream.
Maybe we can adopt the Configuring DevWorkspaces to use SSH keys for Git operations section into Che docs? The file is already in .adoc format, though would need a style pass, etc.
There was a problem hiding this comment.
I don't think we need to have a dedicated page about configuring SSH by a secret. When eclipse-che/che#22111 is done we will point to the user friendly dashboard procedure, so the current procedure will be redundant as a too complicated one. @ibuziuk WDYT?
There was a problem hiding this comment.
I agree we don't need a dedicated page and the link to DWO's doc is sufficient here. My concern is that we need to do some additional work when we downstream these docs later, as I don't think we should be linking to Github there (this is not a necessarily concern for this repo, though).
There was a problem hiding this comment.
if I understand it correctly, you'll make this part visible later?
There was a problem hiding this comment.
if I understand it correctly, you'll make this part visible later?
This is already visible:
It should be modified later
There was a problem hiding this comment.
got it! thanks for the clarification
|
@deerskindoll Could you please review the PR? |
|
I created a PR that will fix the issue with building and validating the PR but it needs to be approved before I can merge it: #2643 |
modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc
Outdated
Show resolved
Hide resolved
| [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]. |
There was a problem hiding this comment.
if I understand it correctly, you'll make this part visible later?
modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc
Outdated
Show resolved
Hide resolved
…lone-of-a-git-repository.adoc Co-authored-by: Jana Vrbkova <[email protected]>
…lone-of-a-git-repository.adoc Co-authored-by: Jana Vrbkova <[email protected]>
…lone-of-a-git-repository.adoc Co-authored-by: Jana Vrbkova <[email protected]>
|
@deerskindoll Could you please approve the PR for the |
sorry, it was a misclick |
What does this pull request change?
Add some info about starting a workspace from SSH Urls
What issues does this pull request fix or reference?
eclipse-che/che-server#539
Specify the version of the product this pull request applies to
next
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.