Add info about starting a workspace from raw devfile location #2563
Conversation
Signed-off-by: Igor Vinokur <[email protected]>
vinokurig
requested review from
rkratky,
max-cx,
deerskindoll and
a team
as code owners
|
Click here to review and test in web IDE: |
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
|
🎊 Navigate the preview: https://63ff1aaa4f46d056a066c9d6--eclipse-che-docs-pr.netlify.app 🎊 |
| + | ||
| [TIP] | ||
| ==== | ||
| You can pass Personal Access Token to the URL to have access to private repositories: |
There was a problem hiding this comment.
maybe we can add info that this would work for GitHub, GitLab, Bitbucket, Azure, and other types repositories that support this type of OAuth
modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc
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
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
| @@ -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>__`. | |||
|
|
|||
| .. Using a direct URL to `devfile`: | |||
There was a problem hiding this comment.
FYI, this step is now in the wrong place: it's currently placed after the workspace has been started.
I also think this step makes the procedure difficult to follow and less readable.
In my personal opinion, the best solution to this update is to turn this page file into an assembly with two procedures in two separate proc_... files as follows:
- Start a new branch from
main(not from the branch of this PR). - In the new assembly file, keep the original heading and original file name (
starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc), the original three intro paragraphs, and move up to them both the original bottom tip about browser bookmark managers and original Additional resources. - You can think of some parallel headings for two new procedure files, e.g.:
= Starting a new workspace from a Git-repository URL
= Starting a new workspace from a devfile URL
- Under Additional resources in the assembly file, add two include statements for the two
proc_...files. - Introduce the two new procedures in the intro of the assembly file as unordered list items.
- Move the original content starting from the first tip ("You can also use the Git Repo URL ...") up to and including "The workspace has a unique URL" to a new
proc_...file that has the heading like= Starting a new workspace from a Git-repository URL. - There, move and tweak the following sentence into a new Verification section as a separate verification step (will be the same for both procedures):
A clone of the Git repository is present in the filesystem of the new workspace.
- There, consider turning the following sentence into a NOTE (will be the same for both procedures):
The workspace has a unique URL: https://<che_fqdn>#workspace<unique_url>.
- After you finalize the first procedure file, copy all its content into the second procedure file, and there incorporate the new content from this PR that's currently in step 2b) "Using a direct URL to devfile:" and as related to it elsewhere.
There was a problem hiding this comment.
thanks for the input, I was thinking along similar lines but didn't have as precise a picture in my head as you just described.
…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]>
| 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> |
There was a problem hiding this comment.
@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
|
@max-cx @deerskindoll @ibuziuk Closing this PR and opening a new one with the separate page approach. Please take a look: #2566 |
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
eclipse-che/che-server#451
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.