Add info about starting a workspace from raw devfile location

[vinokurig]

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.

• Any procedure:
  • Successfully tested.
• Any page or link rename:
  • The page contains a redirection for the previous URL.
  • Propagate the URL change in:
    • Dashboard default branding data
    • Chectl constants.ts
• Builds on Eclipse Che hosted by Red Hat.
• the Validate language on files added or modified step reports no vale warnings.

[github-actions]

Click here to review and test in web IDE:

[github-actions]

Click here to review and test in web IDE:

[github-actions]

🎊 Navigate the preview: https://63ff1aaa4f46d056a066c9d6--eclipse-che-docs-pr.netlify.app 🎊

[ibuziuk]

maybe we can add info that this would work for GitHub, GitLab, Bitbucket, Azure, and other types repositories that support this type of OAuth

[vinokurig]

done

[deerskindoll]

added a couple of suggestions

[max-cx]

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:

1. Start a new branch from main (not from the branch of this PR).
2. 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.
3. 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

4. Under Additional resources in the assembly file, add two include statements for the two proc_... files.
5. Introduce the two new procedures in the intro of the assembly file as unordered list items.
6. 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.
7. 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.

8. 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>.

9. 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.

[deerskindoll]

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.

[ibuziuk]

@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

[vinokurig]

@max-cx @deerskindoll @ibuziuk Closing this PR and opening a new one with the separate page approach. Please take a look: #2566