Skip to content
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

Jump to bottom

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

Merged
merged 9 commits into from
Mar 2, 2023
Merged

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

merged 9 commits into from
Mar 2, 2023

Conversation

vinokurig
Copy link
Contributor

What does this pull request change?

Add info about starting a workspace from raw devfile location

What issues does this pull request fix or reference?

eclipse-che/che#21998

Specify the version of the product this pull request applies to

7.60

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.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

@vinokurig vinokurig requested review from rkratky, max-cx, deerskindoll and a team as code owners March 1, 2023 13:43
@vinokurig vinokurig requested a review from nickboldt March 1, 2023 13:43
@github-actions
Copy link

github-actions bot commented Mar 1, 2023 •
edited
Loading

🎊 Navigate the preview: https://6400b0485c4ffa2040c064c2--eclipse-che-docs-pr.netlify.app 🎊

@github-actions
Copy link

github-actions bot commented Mar 1, 2023

Click here to review and test in web IDE: Contribute

@github-actions
Copy link

github-actions bot commented Mar 1, 2023

Click here to review and test in web IDE: Contribute

@vinokurig vinokurig mentioned this pull request Mar 1, 2023
Closed
6 tasks
@vinokurig
Copy link
Contributor Author

vinokurig commented Mar 1, 2023 •
edited
Loading

@deerskindoll @max-cx Could you please help with the linting error? According to the error description it fails because of the Repo word, but I wonder why it doesn't fail on the original page.

@deerskindoll
Copy link
Contributor

@deerskindoll @max-cx Could you please help with the linting error? According to the error description it fails because of the Repo word, but I wonder why it doesn't fail on the original page.

checking.

@max-cx
Copy link
Contributor

max-cx commented Mar 1, 2023

@vinokurig, I've just fixed it with c90f061.

ibuziuk
ibuziuk reviewed Mar 1, 2023
View reviewed changes
modules/end-user-guide/pages/starting-a-new-workspace-from-a-devfile-url.adoc Outdated
Comment on lines 61 to 70
====
You can pass Personal Access Token to the URL to have access to private repositories:
[source,subs="+quotes,+attributes,+macros"]
----
pass:c,a,q[{prod-url}]#__https://__<token>__@__<host>__/__<path> <1>
----
<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.
====
Copy link
Member

@ibuziuk ibuziuk Mar 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

great job @vinokurig 👍 smth. we discussed with @l0rd today that the PAT in URL feature really shines when we use it together with the remotes attribute ?remotes={<git-repo-url>} and configured SSH key:

  • user has a private repo with devfile hosted on some unsupported provider e.g. gogs
  • user configures ssh key for this provider
  • user starts workspace using the URL with token for basic auth and remote attribute:

pass:c,a,q[{prod-url}]#__https://__<token>__@__<host>__/__<path>?remotes={<git-repo-url>}

  • SUCCESS: che server resolves devfile + project is cloned (using ssh) correctly after workspace startup

I believe we can document this in a separate PR and introduce dedicated section in the docs as part of eclipse-che/che#21951

@ibuziuk
Copy link
Member

ibuziuk commented Mar 1, 2023

@max-cx @deerskindoll thank you for the can we merge the PR now?

vinokurig and others added 2 commits March 2, 2023 14:25
@vinokurig @max-cx
Update modules/end-user-guide/pages/starting-a-new-workspace-from-a-d…
624f71c 
…evfile-url.adoc

Co-authored-by: Max Leonov <mleonov@redhat.com>
@vinokurig @max-cx
Update modules/end-user-guide/pages/starting-a-new-workspace-from-a-d…
3dc6b7c 
…evfile-url.adoc

Co-authored-by: Max Leonov <mleonov@redhat.com>
@l0rd l0rd mentioned this pull request Mar 2, 2023
Closed
deerskindoll
deerskindoll reviewed Mar 2, 2023
View reviewed changes
Copy link
Contributor

@deerskindoll deerskindoll left a comment

Choose a reason for hiding this comment

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

a couple of suggestions

modules/end-user-guide/pages/starting-a-new-workspace-from-a-devfile-url.adoc Outdated Show resolved Hide resolved
modules/end-user-guide/pages/starting-a-new-workspace-from-a-devfile-url.adoc Outdated Show resolved Hide resolved
modules/end-user-guide/pages/starting-a-new-workspace-from-a-devfile-url.adoc Outdated Show resolved Hide resolved
modules/end-user-guide/pages/starting-a-new-workspace-from-a-devfile-url.adoc Outdated Show resolved Hide resolved
vinokurig and others added 4 commits March 2, 2023 16:11
@vinokurig @deerskindoll
Update modules/end-user-guide/pages/starting-a-new-workspace-from-a-d…
4f9b54a 
…evfile-url.adoc

Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com>
@vinokurig @deerskindoll
Update modules/end-user-guide/pages/starting-a-new-workspace-from-a-d…
702d3a7 
…evfile-url.adoc

Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com>
@vinokurig @deerskindoll
Update modules/end-user-guide/pages/starting-a-new-workspace-from-a-d…
e9ddb51 
…evfile-url.adoc

Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com>
@vinokurig @deerskindoll
Update modules/end-user-guide/pages/starting-a-new-workspace-from-a-d…
452fe9d 
…evfile-url.adoc

Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com>
deerskindoll
deerskindoll approved these changes Mar 2, 2023
View reviewed changes
Copy link
Contributor

@deerskindoll deerskindoll left a comment

Choose a reason for hiding this comment

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

lgtm

@deerskindoll deerskindoll merged commit 6d0cba4 into main Mar 2, 2023
@deerskindoll deerskindoll deleted the che-21998_1 branch March 2, 2023 17:48
@che-bot che-bot added this to the 7.62 milestone Mar 2, 2023
deerskindoll added a commit that referenced this pull request Mar 6, 2023
@vinokurig @max-cx @deerskindoll
Add info about starting a workspace from raw devfile location (#2566)
13a5d67 
Co-authored-by: Max Leonov <mleonov@redhat.com>
Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com>
@devstudio-release devstudio-release mentioned this pull request Mar 9, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@max-cx max-cx max-cx left review comments

@ibuziuk ibuziuk ibuziuk approved these changes

@deerskindoll deerskindoll deerskindoll approved these changes

@rkratky rkratky Awaiting requested review from rkratky

@nickboldt nickboldt Awaiting requested review from nickboldt nickboldt is a code owner automatically assigned from eclipse-che/ecd-che-docs-reviewers

Assignees

@deerskindoll deerskindoll

Labels
backported to 7.60.x kind/enhancement target/branch
Projects
None yet
Milestone
7.62
Development

Successfully merging this pull request may close these issues.
5 participants
@vinokurig @deerskindoll @max-cx @ibuziuk @che-bot