From 231b94d2d64b2a4d17b687a5331814a40912fadb Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Tue, 7 Dec 2021 18:10:22 +0100 Subject: [PATCH 01/26] modified Spelling.yml --- .vale/styles/CheDocs/Spelling.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.vale/styles/CheDocs/Spelling.yml b/.vale/styles/CheDocs/Spelling.yml index d655cb15fd..1c617794e3 100644 --- a/.vale/styles/CheDocs/Spelling.yml +++ b/.vale/styles/CheDocs/Spelling.yml @@ -32,6 +32,7 @@ filters: - "[gG]it" - "[gG]rafana" - "[hH]eatmap" + - "[hH]ostname" - "[hH]yperconverged" - "[iI]node" - "[iI]tem" From d941e41cd2d093735da29e785d31ce3e229733b2 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Tue, 7 Dec 2021 18:21:08 +0100 Subject: [PATCH 02/26] modified Spelling.yml --- .vale/styles/CheDocs/Spelling.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.vale/styles/CheDocs/Spelling.yml b/.vale/styles/CheDocs/Spelling.yml index 1c617794e3..7fefdcaad3 100644 --- a/.vale/styles/CheDocs/Spelling.yml +++ b/.vale/styles/CheDocs/Spelling.yml @@ -191,6 +191,7 @@ filters: - Pytorch - Quarkus - Redistributions + - restic - Rolfe - SCM - Shadowman From 165265d1dab83c96c71d281ed43dac3abf2fbe30 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Tue, 29 Mar 2022 10:39:53 +0200 Subject: [PATCH 03/26] draft --- modules/end-user-guide/nav.adoc | 4 + ...ctions-you-can-perform-on-a-workspace.adoc | 35 ++++++ ...the-urls-for-starting-a-new-workspace.adoc | 111 ++++++++++++++++++ ...pace-with-a-clone-of-a-git-repository.adoc | 86 ++++++++++++++ .../end-user-guide/pages/user-onboarding.adoc | 16 +++ 5 files changed, 252 insertions(+) create mode 100644 modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc create mode 100644 modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc create mode 100644 modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc create mode 100644 modules/end-user-guide/pages/user-onboarding.adoc diff --git a/modules/end-user-guide/nav.adoc b/modules/end-user-guide/nav.adoc index c13056fce3..6e92cd9f3d 100644 --- a/modules/end-user-guide/nav.adoc +++ b/modules/end-user-guide/nav.adoc @@ -1,5 +1,9 @@ .User Guide +* xref:user-onboarding.adoc[] +** xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[] +** xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[] +** xref:basic-actions-you-can-perform-on-a-workspace.adoc[] * xref:using-developer-workspaces.adoc[] ** xref:first-time-contributors.adoc[] ** xref:benefits-of-pull-requests-review-in-che.adoc[] diff --git a/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc b/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc new file mode 100644 index 0000000000..bfd39a4bf9 --- /dev/null +++ b/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc @@ -0,0 +1,35 @@ +:_content-type: REFERENCE +:description: Basic actions you can perform on a workspace +:keywords: running-workspace, stopped-workspace, open-workspace, open-a-workspace, open-a-running-workspace, opening-workspace, opening-a-workspace, opening-a-running-workspace, how-to-open-workspace, how-to-open-a-workspace, how-to-open-a-running-workspace, reopen-workspace, reopen-a-workspace, reopen-a-running-workspace, reopening-workspace, reopening-a-workspace, reopening-a-running-workspace, how-to-reopen-workspace, how-to-reopen-a-workspace, how-to-reopen-a-running-workspace, restart-workspace, restart-a-workspace, restart-a-running-workspace, restarting-workspace, restarting-a-workspace, restarting-a-running-workspace, how-to-restart-workspace, how-to-restart-a-workspace, how-to-restart-a-running-workspace, stop-workspace, stop-a-workspace, stop-a-running-workspace, stopping-workspace, stopping-a-workspace, stopping-a-running-workspace, how-to-stop-workspace, how-to-stop-a-workspace, how-to-stop-a-running-workspace, start-workspace, start-a-workspace, start-stopped-workspace, start-a-stopped-workspace, starting-workspace, starting-a-workspace, starting-stopped-workspace, starting-a-stopped-workspace, how-to-start-workspace, how-to-start-a-workspace, how-to-start-stopped-workspace, how-to-start-a-stopped-workspace, delete-workspace, delete-a-workspace, deleting-workspace, deleting-a-workspace, how-to-delete-workspace, how-to-delete-a-workspace +:navtitle: Basic actions you can perform on a workspace +// :page-aliases: + +[id="basic-actions-you-can-perform-on-a-workspace_{context}"] += Basic actions you can perform on a workspace + +You manage your workspaces and verify their current states in the *Workspaces* page (`{prod-url}/dashboard/#/workspaces`) of your {prod-short} dashboard. + +After you start a new workspace, you can perform the following actions on it in the *Workspaces* page: + +.Basic actions you can perform on a workspace +|=== +| Action | GUI steps in the Workspaces page + +| _Reopen a running workspace_ +| Click *Open*. + +| _Restart a running workspace_ +| Go to *⋮* *>* *Restart Workspace*. + +| _Stop a running workspace_ +| Go to *⋮* *>* *Stop Workspace*. + +| _Start a stopped workspace_ +| Click *Open*. + +| _Delete a workspace_ +| Go to *⋮* *>* *Delete Workspace*. + +|=== + +IMPORTANT: When you stop a workspace, its state at the moment you stopped it is preserved until you restart it. And if you do not stop a running workspace manually, it stops automatically when it reaches an idle timeout limit or a running timeout limit, which are set by the administrator of your organization's {prod-short} instance. When the workspace stops automatically because of a timeout limit, its latest state is preserved until you restart it. \ No newline at end of file diff --git a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc new file mode 100644 index 0000000000..7459925970 --- /dev/null +++ b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc @@ -0,0 +1,111 @@ +:_content-type: CONCEPT +:description: Optional parameters for the URLs for starting a new workspace +:keywords: url, urls, parameter, parameters, starting, start, workspace, workspaces, url-parameter, url-parameters, multiple-url-parameters, combine-url-parameters, several-url-parameters, add-url-parameters, concatenate, concatenate-multiple-URL-parameters, concatenate-URL-parameters, concatenating, concatenating-multiple-URL-parameters, concatenating-URL-parameters, concatenation, start-duplicate-workspaces, start-duplicated-workspaces, duplicate-workspace, duplicate-workspaces, duplicated-workspace, duplicated-workspaces, how-to-start-a-duplicate, how-to-start-duplicate, devfile, override-devfile-file-name, override-file-name, file-name, devfile-name, different-devfile-name, file-path, devfile-path, devfile-file-path, devfile-path-parameter, devfile-file-path-parameterdevfile, file-path, devfile-path, devfile-file-path, devfile-path-parameter, devfile-file-path-parameter +:navtitle: Optional parameters for the URLs for starting a new workspace +// :page-aliases: + +[id="parameters-for-the-urls-for-starting-a-new-workspace_{context}"] += Optional parameters for the URLs for starting a new workspace + +For the URLs for starting a new workspace, the following optional parameters provide an extra layer of basic workspace configuration in addition to the devfile. +//here link to a section about the devfile. max-cx + +== URL parameter concatenation + +The URL for starting a new workspace supports concatenation of multiple URL parameters by using `&` with the following URL syntax: +[source,subs="+quotes,+attributes"] +---- +{prod-url}#____?____&____&____ +---- + +== URL parameter for the workspace IDE + +Che-Theia is currently the default integrated development environment (IDE) that a workspace loads with if no IDE is specified as a URL parameter as part of the URL for starting a new workspace. + +The URL parameter for specifying another supported IDE is `che-editor=____`. + +The URL for starting a new workspace has the following syntax with the `che-editor=____` parameter: + +[source,subs="+quotes,+attributes"] +---- +{prod-url}#____?che-editor=____ +---- + +.`____` values for supported IDEs +|=== +| IDE | `____` value | Note + +ifeval::["{project-context}" == "che"] +| link:https://github.com/eclipse-che/che-theia[Che-Theia] +| `eclipse/che-theia/latest` +| This is the default IDE with link:https://github.com/che-incubator/chectl/[chectl stable]. This IDE loads in a new workspace without entering this URL parameter. + +| link:https://github.com/eclipse-che/che-theia[Che-Theia] +| `eclipse/che-theia/next` +| This is the default IDE with link:https://github.com/che-incubator/chectl/[chectl next]. This IDE loads in a new workspace without entering this URL parameter. +endif::[] + +ifeval::["{project-context}" == "crw"] +| link:https://github.com/eclipse-che/che-theia[Che-Theia] +|`eclipse/che-theia/latest` +| This is the default IDE: it loads in a new workspace without this URL parameter. +endif::[] + +| link:https://coder.com/docs/code-server/[*code-server*] +| `che-incubator/che-code/insiders` +| + +| link:https://www.jetbrains.com/help/idea/discover-intellij-idea.html[*IntelliJ IDEA Community Edition*] +| `che-incubator/intellij-community/latest` +| + +| link:https://www.jetbrains.com/help/pycharm/quick-start-guide.html[*PyCharm*] +| `che-incubator/pycharm/latest` +| + +|=== + +== URL parameter for starting duplicate workspaces + +Visiting a URL for starting a new workspace results in a workspace that is based on a combination of a devfile and a linked Git repository. + +In some situations, you may need to start one or more workspaces from the same URL for starting a new workspace, resulting in workspaces that are duplicates in terms of the same devfile and the same linked Git repository. The URL parameter for starting a duplicate workspace is `new`. + +The URL for starting a new workspace has the following syntax with the `new` parameter: + +[source,subs="+quotes,+attributes"] +---- +{prod-url}#____?new +---- + +NOTE: Attempting to reuse the devfile and linked Git repository without the `new` URL parameter to start a new workspace in addition to a workspace that already exists results in an error message. + +== URL parameter for the devfile file name + +When you visit a URL for starting a new workspace, {prod-short} searches the linked Git repository for a devfile with the file name `.devfile.yaml` or `devfile.yaml`. So the devfile in the linked Git repository must follow this convention. + +In some situations, you may need to specify a different, unconventional file name for the devfile. The URL parameter for specifying an unconventional file name of the devfile is `df=____.yaml`. + +The URL for starting a new workspace has the following syntax with the `df=____.yaml` parameter: + +[source,subs="+quotes,+attributes"] +---- +{prod-url}#____?df=____.yaml <1> +---- +<1> `____.yaml` is an unconventional file name of the devfile in the linked Git repository. + +TIP: The `df=____.yaml` parameter also has a long version: `devfilePath=____.yaml`. + +== URL parameter for the devfile file path + +When you visit a URL for starting a new workspace, {prod-short} searches the root directory of the linked Git repository for a devfile (with the file name `.devfile.yaml` or `devfile.yaml`). So the file path of the devfile in the linked Git repository must follow this convention. + +In some situations, you may need to specify a different, unconventional file path for the devfile in the linked Git repository. The URL parameter for specifying an unconventional file path of the devfile is `devfilePath=____`. + +The URL for starting a new workspace has the following syntax with the `devfilePath=____` parameter: + +[source,subs="+quotes,+attributes"] +---- +{prod-url}#____?devfilePath=____ <1> +---- +<1> `____` is an unconventional file path of the devfile in the linked Git repository. \ No newline at end of file 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 new file mode 100644 index 0000000000..19bf1b5bab --- /dev/null +++ b/modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc @@ -0,0 +1,86 @@ +:_content-type: PROCEDURE +:description: Starting a new workspace with a clone of a Git repository +:keywords: start-new-workspace, start-a-new-workspace, how-to-start-new-workspace, how-to-start-a-new-workspace, starting-a-new-workspace, clone-git-repository, clone-a-git-repository, how-to-start-workspace, how-to-start-a-workspace +:navtitle: Starting a new workspace with a clone of a Git repository +// :page-aliases: + +[id="starting-a-new-workspace-with-a-clone-of-a-git-repository_{context}"] += Starting a new workspace with a clone of a Git repository + +Working with {prod-short} in your browser involves multiple URLs: + +* URL of your organization's {prod-short} instance (as part of all the following URLs) +* URL of the *Workspaces* page of your {prod-short} dashboard (workspace control panel) +* [.underline]#URLs for starting a new workspace# +* 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. So you can have your remote origin or fork cloned into a new starting workspace. Or you can have a common repository of a project cloned into a new starting workspace. With such Git providers as GitHub and GitLab, you can also specify the branch for the new starting workspace to checkout. + +NOTE: The *Create Workspace* page of your {prod-short} dashboard has the *Git Repo URL ** field as the limited-functionality GUI alternative for entering the URL of a Git repository to start a new workspace. + +.Prerequisites + +* Your organization has a running instance of {prod-short}. +* The administrator of your organization's {prod-short} instance or the repository maintainer or the README author has provided you with the URL of your organization's {prod-short} instance that you need as a user to access your {prod-short} dashboard pages and start and manage your workspaces. This URL is a fully qualified domain name (FQDN): `{prod-url}`. +* Your Git repository maintainer keeps the `devfile.yaml` or `.devfile.yaml` file in the root directory of the Git repository. (For alternative file names and file paths, see xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[].) ++ +IMPORTANT: Although the devfile enables full functionality of a workspace, you can also start a new workspace by supplying the URL of a Git repository without a devfile. This results in a new workspace with a clone of the Git repository and with the defaults such as the Che-Theia IDE and the Universal Developer Image. +//provide xrefs to a concept module about the Universal Developer Image and, if applicable, devfile-less defaults for new workspaces. max-cx ++ +TIP: Advanced users can compose and use their own devfiles. +//add links on "compose" or "devfiles" to relevant sections when those are drafted. max-cx +* Optional: Private repositories that are hosted on GitHub, GitLab, or Bitbucket require +.. an authorized application link to be created on the repository-hosting website and +.. a Kubernetes secret to be applied by the administrator of your organization's {prod-short} instance. +//two inline links to be added into this par in the next, separate PR. max-cx +//* "Kubernetes" rather than {platforms-name} requested by Mario. max-cx + +.Procedure + +. Optional: visit your {prod-short} dashboard page to authenticate as a {prod-short} user to your organization's instance of {prod-short}. + +. Visit the URL to start a new workspace using the basic syntax: +[source,subs="+quotes,+attributes"] ++ +---- +{prod-url}#____ +---- ++ +[TIP] +==== +You can extend this URL with optional parameters: +[source,subs="+quotes,+attributes"] +---- +{prod-url}#____?____ <1> +---- +<1> See xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]. +==== ++ +.URL syntax for starting a new workspace that contains a clone of a GitHub-hosted repository +==== +* `pass:c,a,q[{prod-url}#https://github.com/____/____]` starts a new workspace with a clone of the default branch. +* `pass:c,a,q[{prod-url}#https://github.com/____/____/tree/____]` starts a new workspace with a clone of the specified branch. +* `pass:c,a,q[{prod-url}#https://github.com/____/____/pull/____]` starts a new workspace with a clone of the branch of the pull request. +==== ++ +After you enter the URL to start a new workspace in a browser tab, it renders the workspace-starting page in *Progress*. ++ +When the new workspace is ready, the workspace GUI loads in the browser tab. ++ +A clone of the Git repository is present in the filesystem of the new workspace. ++ +NOTE: Each workspace has a unique URL: `{prod-url}#workspace____`. + +[TIP] +==== +To add a URL as a bookmark in a browser: + +* In Mozilla Firefox, go to *☰* *>* *Bookmarks* *>* *Manage bookmarks Ctrl+Shift+O* *>* *Bookmarks Toolbar* *>* *Organize* *>* *Add bookmark*. + +* In Google Chrome, go to *⋮* *>* *Bookmarks* *>* *Bookmark manager* *>* *Bookmarks bar* *>* *⋮* *>* *Add new bookmark*. +==== + +.Additional resources + +* xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[] +* xref:basic-actions-you-can-perform-on-a-workspace.adoc[] \ No newline at end of file diff --git a/modules/end-user-guide/pages/user-onboarding.adoc b/modules/end-user-guide/pages/user-onboarding.adoc new file mode 100644 index 0000000000..3b77f4be76 --- /dev/null +++ b/modules/end-user-guide/pages/user-onboarding.adoc @@ -0,0 +1,16 @@ +:_content-type: CONCEPT +:description: User onboarding +:keywords: getting-started, user-onboarding, new-user, new-users, user-guide +:navtitle: User onboarding +// :page-aliases: + +[id="user-onboarding_{context}"] += User onboarding + +If your organization is already running a {prod-short} instance, you can get started as a new user of {prod-short} by first learning how to start a new workspace and how to manage your workspaces: + +. xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[] +. xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[] +. xref:basic-actions-you-can-perform-on-a-workspace.adoc[] + +Beyond this, it's likely that your organization has its own onboarding needs regarding its Git repositories, {prod-short} related instructions in the READMEs or elsewhere documented team-level instructions, and the devfiles that reside in the GIt repositories and that are responsible for workspace configuration. \ No newline at end of file From b364a1a637bdca54a8cb84843c3d11aca360b7d0 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Tue, 29 Mar 2022 10:45:51 +0200 Subject: [PATCH 04/26] draft --- antora.yml | 2 +- modules/end-user-guide/pages/user-onboarding.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/antora.yml b/antora.yml index e17789cf10..7af8451b5a 100644 --- a/antora.yml +++ b/antora.yml @@ -74,7 +74,7 @@ asciidoc: prod-prev-ver: "previous minor version" prod-short: Che prod-upstream: Eclipse{nbsp}Che - prod-url: "https://__<che_fqdn>__" + prod-url: https://<che_fqdn> prod-ver-major: "7" prod-ver-patch: main prod-ver: main diff --git a/modules/end-user-guide/pages/user-onboarding.adoc b/modules/end-user-guide/pages/user-onboarding.adoc index 3b77f4be76..80d208aff7 100644 --- a/modules/end-user-guide/pages/user-onboarding.adoc +++ b/modules/end-user-guide/pages/user-onboarding.adoc @@ -13,4 +13,4 @@ If your organization is already running a {prod-short} instance, you can get sta . xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[] . xref:basic-actions-you-can-perform-on-a-workspace.adoc[] -Beyond this, it's likely that your organization has its own onboarding needs regarding its Git repositories, {prod-short} related instructions in the READMEs or elsewhere documented team-level instructions, and the devfiles that reside in the GIt repositories and that are responsible for workspace configuration. \ No newline at end of file +Beyond this, it's likely that your organization has its own onboarding needs regarding its Git repositories, {prod-short} related instructions in the READMEs or elsewhere documented team-level instructions, and the devfiles that reside in the Git repositories and that are responsible for workspace configuration. \ No newline at end of file From 712dbab519c7aa44493755dd0ff68baf4ff1db95 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Tue, 29 Mar 2022 12:06:36 +0200 Subject: [PATCH 05/26] procedures: user onboarding, starting a new workspace, url parameters --- modules/end-user-guide/pages/user-onboarding.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/end-user-guide/pages/user-onboarding.adoc b/modules/end-user-guide/pages/user-onboarding.adoc index 80d208aff7..caadc4dfb7 100644 --- a/modules/end-user-guide/pages/user-onboarding.adoc +++ b/modules/end-user-guide/pages/user-onboarding.adoc @@ -1,6 +1,6 @@ :_content-type: CONCEPT :description: User onboarding -:keywords: getting-started, user-onboarding, new-user, new-users, user-guide +:keywords: getting-started, user-onboarding, new-user, new-users :navtitle: User onboarding // :page-aliases: From 296e31f724de5e0326253a0b4fe67636b36c9aee Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Wed, 30 Mar 2022 14:06:31 +0200 Subject: [PATCH 06/26] draft --- ...g-a-new-workspace-with-a-clone-of-a-git-repository.adoc | 6 +++--- modules/end-user-guide/pages/user-onboarding.adoc | 7 ++++++- 2 files changed, 9 insertions(+), 4 deletions(-) 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 19bf1b5bab..4ed1aa62d1 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 @@ -37,7 +37,7 @@ TIP: Advanced users can compose and use their own devfiles. .Procedure -. Optional: visit your {prod-short} dashboard page to authenticate as a {prod-short} user to your organization's instance of {prod-short}. +. Optional: Visit your {prod-short} dashboard page to authenticate as a {prod-short} user to your organization's instance of {prod-short}. . Visit the URL to start a new workspace using the basic syntax: [source,subs="+quotes,+attributes"] @@ -63,7 +63,7 @@ You can extend this URL with optional parameters: * `pass:c,a,q[{prod-url}#https://github.com/____/____/pull/____]` starts a new workspace with a clone of the branch of the pull request. ==== + -After you enter the URL to start a new workspace in a browser tab, it renders the workspace-starting page in *Progress*. +After you enter the URL to start a new workspace in a browser tab, it renders the workspace-starting page. + When the new workspace is ready, the workspace GUI loads in the browser tab. + @@ -73,7 +73,7 @@ NOTE: Each workspace has a unique URL: `{prod-url}#workspace____`. [TIP] ==== -To add a URL as a bookmark in a browser: +Browser bookmark managers permit adding a URL for starting a new workspace as a bookmark, which is not possible in the address bar: * In Mozilla Firefox, go to *☰* *>* *Bookmarks* *>* *Manage bookmarks Ctrl+Shift+O* *>* *Bookmarks Toolbar* *>* *Organize* *>* *Add bookmark*. diff --git a/modules/end-user-guide/pages/user-onboarding.adoc b/modules/end-user-guide/pages/user-onboarding.adoc index caadc4dfb7..fff204a27d 100644 --- a/modules/end-user-guide/pages/user-onboarding.adoc +++ b/modules/end-user-guide/pages/user-onboarding.adoc @@ -13,4 +13,9 @@ If your organization is already running a {prod-short} instance, you can get sta . xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[] . xref:basic-actions-you-can-perform-on-a-workspace.adoc[] -Beyond this, it's likely that your organization has its own onboarding needs regarding its Git repositories, {prod-short} related instructions in the READMEs or elsewhere documented team-level instructions, and the devfiles that reside in the Git repositories and that are responsible for workspace configuration. \ No newline at end of file +Beyond this, it's likely that your organization has its own onboarding needs regarding: + +* Specific Git repositories +* Devfiles that reside in the specific Git repositories and that are responsible for workspace configuration +* {prod-short} related instructions in the READMEs +* Team-level processes and procedures \ No newline at end of file From f56675f1923605e68b42e3917fe524a69b2910c5 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Mon, 4 Apr 2022 15:21:50 +0200 Subject: [PATCH 07/26] Update modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc Co-authored-by: Rolfe Dlugy-Hegwer --- .../pages/basic-actions-you-can-perform-on-a-workspace.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc b/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc index bfd39a4bf9..e4b3804a83 100644 --- a/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc +++ b/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc @@ -32,4 +32,4 @@ After you start a new workspace, you can perform the following actions on it in |=== -IMPORTANT: When you stop a workspace, its state at the moment you stopped it is preserved until you restart it. And if you do not stop a running workspace manually, it stops automatically when it reaches an idle timeout limit or a running timeout limit, which are set by the administrator of your organization's {prod-short} instance. When the workspace stops automatically because of a timeout limit, its latest state is preserved until you restart it. \ No newline at end of file +IMPORTANT: Stopping a workspace preserves its state until it restarts. This is true whether you stop the workspace or it reaches the idle timeout limit or running timeout limit set by your {prod-short} cluster administrator. \ No newline at end of file From 37eb704bb582bd1e50cc3d52716edecda8e7735d Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Mon, 4 Apr 2022 19:23:25 +0200 Subject: [PATCH 08/26] draft --- ...-for-the-urls-for-starting-a-new-workspace.adoc | 6 +++--- ...workspace-with-a-clone-of-a-git-repository.adoc | 14 ++++---------- 2 files changed, 7 insertions(+), 13 deletions(-) diff --git a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc index 7459925970..4e9d92cac5 100644 --- a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc +++ b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc @@ -51,15 +51,15 @@ ifeval::["{project-context}" == "crw"] | This is the default IDE: it loads in a new workspace without this URL parameter. endif::[] -| link:https://coder.com/docs/code-server/[*code-server*] +| link:https://github.com/che-incubator/che-code[Che-Code] | `che-incubator/che-code/insiders` | -| link:https://www.jetbrains.com/help/idea/discover-intellij-idea.html[*IntelliJ IDEA Community Edition*] +| link:https://www.jetbrains.com/help/idea/discover-intellij-idea.html[IntelliJ IDEA Community Edition] | `che-incubator/intellij-community/latest` | -| link:https://www.jetbrains.com/help/pycharm/quick-start-guide.html[*PyCharm*] +| link:https://www.jetbrains.com/help/pycharm/quick-start-guide.html[PyCharm] | `che-incubator/pycharm/latest` | 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 4ed1aa62d1..3d72626512 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 @@ -9,10 +9,10 @@ Working with {prod-short} in your browser involves multiple URLs: -* URL of your organization's {prod-short} instance (as part of all the following URLs) -* URL of the *Workspaces* page of your {prod-short} dashboard (workspace control panel) -* [.underline]#URLs for starting a new workspace# -* URLs of your workspaces in use +* The URL of your organization's {prod-short} instance, used as part of all the following URLs +* The URL of the *Workspaces* page of your {prod-short} dashboard with the workspace control panel +* [.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. So you can have your remote origin or fork cloned into a new starting workspace. Or you can have a common repository of a project cloned into a new starting workspace. With such Git providers as GitHub and GitLab, you can also specify the branch for the new starting workspace to checkout. @@ -28,12 +28,6 @@ IMPORTANT: Although the devfile enables full functionality of a workspace, you c //provide xrefs to a concept module about the Universal Developer Image and, if applicable, devfile-less defaults for new workspaces. max-cx + TIP: Advanced users can compose and use their own devfiles. -//add links on "compose" or "devfiles" to relevant sections when those are drafted. max-cx -* Optional: Private repositories that are hosted on GitHub, GitLab, or Bitbucket require -.. an authorized application link to be created on the repository-hosting website and -.. a Kubernetes secret to be applied by the administrator of your organization's {prod-short} instance. -//two inline links to be added into this par in the next, separate PR. max-cx -//* "Kubernetes" rather than {platforms-name} requested by Mario. max-cx .Procedure From 53c5774c919414fdabf6288edb93d43bfdb5847f Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Tue, 5 Apr 2022 10:45:04 +0200 Subject: [PATCH 09/26] draft --- ...workspace-with-a-clone-of-a-git-repository.adoc | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) 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 3d72626512..57837bc091 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 @@ -24,28 +24,26 @@ NOTE: The *Create Workspace* page of your {prod-short} dashboard has the *Git Re * The administrator of your organization's {prod-short} instance or the repository maintainer or the README author has provided you with the URL of your organization's {prod-short} instance that you need as a user to access your {prod-short} dashboard pages and start and manage your workspaces. This URL is a fully qualified domain name (FQDN): `{prod-url}`. * Your Git repository maintainer keeps the `devfile.yaml` or `.devfile.yaml` file in the root directory of the Git repository. (For alternative file names and file paths, see xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[].) + -IMPORTANT: Although the devfile enables full functionality of a workspace, you can also start a new workspace by supplying the URL of a Git repository without a devfile. This results in a new workspace with a clone of the Git repository and with the defaults such as the Che-Theia IDE and the Universal Developer Image. +IMPORTANT: You can also start a new workspace by supplying the URL of a Git repository that contains no devfile. Doing so results in a workspace with the Che-Theia IDE and the Universal Developer Image. //provide xrefs to a concept module about the Universal Developer Image and, if applicable, devfile-less defaults for new workspaces. max-cx -+ -TIP: Advanced users can compose and use their own devfiles. .Procedure . Optional: Visit your {prod-short} dashboard page to authenticate as a {prod-short} user to your organization's instance of {prod-short}. . Visit the URL to start a new workspace using the basic syntax: -[source,subs="+quotes,+attributes"] +[source,subs="+quotes,+attributes,+macros"] + ---- -{prod-url}#____ +pass:c,a,q[{prod-url}]#____ ---- + [TIP] ==== You can extend this URL with optional parameters: -[source,subs="+quotes,+attributes"] +[source,subs="+quotes,+attributes,+macros"] ---- -{prod-url}#____?____ <1> +pass:c,a,q[{prod-url}]#____?____ <1> ---- <1> See xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]. ==== @@ -63,7 +61,7 @@ When the new workspace is ready, the workspace GUI loads in the browser tab. + A clone of the Git repository is present in the filesystem of the new workspace. + -NOTE: Each workspace has a unique URL: `{prod-url}#workspace____`. +The workspace has a unique URL: `pass:c,a,q[{prod-url}]#workspace____`. [TIP] ==== From cc092151301a5ec7b6332f557b92a6ad02229557 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Tue, 5 Apr 2022 10:48:34 +0200 Subject: [PATCH 10/26] draft --- antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/antora.yml b/antora.yml index 7af8451b5a..e17789cf10 100644 --- a/antora.yml +++ b/antora.yml @@ -74,7 +74,7 @@ asciidoc: prod-prev-ver: "previous minor version" prod-short: Che prod-upstream: Eclipse{nbsp}Che - prod-url: https://<che_fqdn> + prod-url: "https://__<che_fqdn>__" prod-ver-major: "7" prod-ver-patch: main prod-ver: main From 6c915baf1e682c0490a5cd48e5ba1d4c82bea5e5 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Tue, 5 Apr 2022 18:19:03 +0200 Subject: [PATCH 11/26] draft --- ...ctions-you-can-perform-on-a-workspace.adoc | 2 +- ...the-urls-for-starting-a-new-workspace.adoc | 38 ++++++++++--------- 2 files changed, 21 insertions(+), 19 deletions(-) diff --git a/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc b/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc index e4b3804a83..bbaaaaa8ce 100644 --- a/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc +++ b/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc @@ -7,7 +7,7 @@ [id="basic-actions-you-can-perform-on-a-workspace_{context}"] = Basic actions you can perform on a workspace -You manage your workspaces and verify their current states in the *Workspaces* page (`{prod-url}/dashboard/#/workspaces`) of your {prod-short} dashboard. +You manage your workspaces and verify their current states in the *Workspaces* page (`pass:c,a,q[{prod-url}]/dashboard/#/workspaces`) of your {prod-short} dashboard. After you start a new workspace, you can perform the following actions on it in the *Workspaces* page: diff --git a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc index 4e9d92cac5..274bb1c2e2 100644 --- a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc +++ b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc @@ -10,12 +10,14 @@ For the URLs for starting a new workspace, the following optional parameters provide an extra layer of basic workspace configuration in addition to the devfile. //here link to a section about the devfile. max-cx +When you start a workspace, {prod-short} configures the workspace according to the instructions in the devfile. When you use a URL to start a new workspace, you can append optional parameters to the URL that further configure the workspace. You can use these parameters to specify a workspace IDE, start duplicate workspaces, and specify a devfile file name or path. + == URL parameter concatenation The URL for starting a new workspace supports concatenation of multiple URL parameters by using `&` with the following URL syntax: -[source,subs="+quotes,+attributes"] +[source,subs="+quotes,+attributes,+macros"] ---- -{prod-url}#____?____&____&____ +pass:c,a,q[{prod-url}]#____?____&____&____ ---- == URL parameter for the workspace IDE @@ -26,29 +28,29 @@ The URL parameter for specifying another supported IDE is `che-editor=____` parameter: -[source,subs="+quotes,+attributes"] +[source,subs="+quotes,+attributes,+macros"] ---- -{prod-url}#____?che-editor=____ +pass:c,a,q[{prod-url}]#____?che-editor=____ ---- -.`____` values for supported IDEs +.The `____` values for the supported IDEs |=== | IDE | `____` value | Note ifeval::["{project-context}" == "che"] | link:https://github.com/eclipse-che/che-theia[Che-Theia] | `eclipse/che-theia/latest` -| This is the default IDE with link:https://github.com/che-incubator/chectl/[chectl stable]. This IDE loads in a new workspace without entering this URL parameter. +| When using the `stable` link:https://github.com/che-incubator/chectl/[chectl] channel, this IDE loads as a default in a new workspace, without having to enter this URL parameter. | link:https://github.com/eclipse-che/che-theia[Che-Theia] | `eclipse/che-theia/next` -| This is the default IDE with link:https://github.com/che-incubator/chectl/[chectl next]. This IDE loads in a new workspace without entering this URL parameter. +| When using the `next` link:https://github.com/che-incubator/chectl/[chectl] channel, this IDE loads as a default in a new workspace, without having to enter this URL parameter. endif::[] ifeval::["{project-context}" == "crw"] | link:https://github.com/eclipse-che/che-theia[Che-Theia] |`eclipse/che-theia/latest` -| This is the default IDE: it loads in a new workspace without this URL parameter. +| This is the default IDE that loads in a new workspace without this URL parameter. endif::[] | link:https://github.com/che-incubator/che-code[Che-Code] @@ -69,28 +71,28 @@ endif::[] Visiting a URL for starting a new workspace results in a workspace that is based on a combination of a devfile and a linked Git repository. -In some situations, you may need to start one or more workspaces from the same URL for starting a new workspace, resulting in workspaces that are duplicates in terms of the same devfile and the same linked Git repository. The URL parameter for starting a duplicate workspace is `new`. +In some situations, you may need to have multiple workspaces that are duplicates in terms of the devfile and the linked Git repository. You can do this by visiting the same URL for starting a new workspace with a URL parameter. The URL parameter for starting a duplicate workspace is `new`. The URL for starting a new workspace has the following syntax with the `new` parameter: -[source,subs="+quotes,+attributes"] +[source,subs="+quotes,+attributes,+macros"] ---- -{prod-url}#____?new +pass:c,a,q[{prod-url}]#____?new ---- -NOTE: Attempting to reuse the devfile and linked Git repository without the `new` URL parameter to start a new workspace in addition to a workspace that already exists results in an error message. +NOTE: If you currently have a workspace that you started using a URL, then visiting the URL again without the `new` URL parameter results in an error message. == URL parameter for the devfile file name -When you visit a URL for starting a new workspace, {prod-short} searches the linked Git repository for a devfile with the file name `.devfile.yaml` or `devfile.yaml`. So the devfile in the linked Git repository must follow this convention. +When you visit a URL for starting a new workspace, {prod-short} searches the linked Git repository for a devfile with the file name `.devfile.yaml` or `devfile.yaml`. The devfile in the linked Git repository must follow this file-naming convention. In some situations, you may need to specify a different, unconventional file name for the devfile. The URL parameter for specifying an unconventional file name of the devfile is `df=____.yaml`. The URL for starting a new workspace has the following syntax with the `df=____.yaml` parameter: -[source,subs="+quotes,+attributes"] +[source,subs="+quotes,+attributes,+macros"] ---- -{prod-url}#____?df=____.yaml <1> +pass:c,a,q[{prod-url}]#____?df=____.yaml <1> ---- <1> `____.yaml` is an unconventional file name of the devfile in the linked Git repository. @@ -98,14 +100,14 @@ TIP: The `df=____.yaml` parameter also has a long version: `devfilePat == URL parameter for the devfile file path -When you visit a URL for starting a new workspace, {prod-short} searches the root directory of the linked Git repository for a devfile (with the file name `.devfile.yaml` or `devfile.yaml`). So the file path of the devfile in the linked Git repository must follow this convention. +When you visit a URL for starting a new workspace, {prod-short} searches the root directory of the linked Git repository for a devfile (with the file name `.devfile.yaml` or `devfile.yaml`). The file path of the devfile in the linked Git repository must follow this path convention. In some situations, you may need to specify a different, unconventional file path for the devfile in the linked Git repository. The URL parameter for specifying an unconventional file path of the devfile is `devfilePath=____`. The URL for starting a new workspace has the following syntax with the `devfilePath=____` parameter: -[source,subs="+quotes,+attributes"] +[source,subs="+quotes,+attributes,+macros"] ---- -{prod-url}#____?devfilePath=____ <1> +pass:c,a,q[{prod-url}]#____?devfilePath=____ <1> ---- <1> `____` is an unconventional file path of the devfile in the linked Git repository. \ No newline at end of file From 3a52ba61e34af288a2e4098c5e239a4b546b3e89 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Wed, 6 Apr 2022 11:10:55 +0200 Subject: [PATCH 12/26] draft --- ...rameters-for-the-urls-for-starting-a-new-workspace.adoc | 7 ++----- ...g-a-new-workspace-with-a-clone-of-a-git-repository.adoc | 4 ++-- 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc index 274bb1c2e2..88c6c8ef31 100644 --- a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc +++ b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc @@ -7,9 +7,6 @@ [id="parameters-for-the-urls-for-starting-a-new-workspace_{context}"] = Optional parameters for the URLs for starting a new workspace -For the URLs for starting a new workspace, the following optional parameters provide an extra layer of basic workspace configuration in addition to the devfile. -//here link to a section about the devfile. max-cx - When you start a workspace, {prod-short} configures the workspace according to the instructions in the devfile. When you use a URL to start a new workspace, you can append optional parameters to the URL that further configure the workspace. You can use these parameters to specify a workspace IDE, start duplicate workspaces, and specify a devfile file name or path. == URL parameter concatenation @@ -40,11 +37,11 @@ pass:c,a,q[{prod-url}]#____?che-editor=____ ifeval::["{project-context}" == "che"] | link:https://github.com/eclipse-che/che-theia[Che-Theia] | `eclipse/che-theia/latest` -| When using the `stable` link:https://github.com/che-incubator/chectl/[chectl] channel, this IDE loads as a default in a new workspace, without having to enter this URL parameter. +| When using the `stable` link:https://github.com/che-incubator/chectl/[chectl] channel, this IDE loads as a default in a new workspace without this URL parameter. | link:https://github.com/eclipse-che/che-theia[Che-Theia] | `eclipse/che-theia/next` -| When using the `next` link:https://github.com/che-incubator/chectl/[chectl] channel, this IDE loads as a default in a new workspace, without having to enter this URL parameter. +| When using the `next` link:https://github.com/che-incubator/chectl/[chectl] channel, this IDE loads as a default in a new workspace without this URL parameter. endif::[] ifeval::["{project-context}" == "crw"] 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 57837bc091..2106b59db7 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 @@ -21,7 +21,7 @@ NOTE: The *Create Workspace* page of your {prod-short} dashboard has the *Git Re .Prerequisites * Your organization has a running instance of {prod-short}. -* The administrator of your organization's {prod-short} instance or the repository maintainer or the README author has provided you with the URL of your organization's {prod-short} instance that you need as a user to access your {prod-short} dashboard pages and start and manage your workspaces. This URL is a fully qualified domain name (FQDN): `{prod-url}`. +* The administrator of your organization's {prod-short} instance or the repository maintainer or the README author has provided you with the URL of your organization's {prod-short} instance that you need as a user to access your {prod-short} dashboard pages and start and manage your workspaces. This URL is a fully qualified domain name (FQDN): `pass:c,a,q[{prod-url}]`. * Your Git repository maintainer keeps the `devfile.yaml` or `.devfile.yaml` file in the root directory of the Git repository. (For alternative file names and file paths, see xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[].) + IMPORTANT: You can also start a new workspace by supplying the URL of a Git repository that contains no devfile. Doing so results in a workspace with the Che-Theia IDE and the Universal Developer Image. @@ -65,7 +65,7 @@ The workspace has a unique URL: `pass:c,a,q[{prod-url}]#workspace___ [TIP] ==== -Browser bookmark managers permit adding a URL for starting a new workspace as a bookmark, which is not possible in the address bar: +Although this is not possible in the address bar, you can add a URL for starting a new workspace as a bookmark by using the browser bookmark manager: * In Mozilla Firefox, go to *☰* *>* *Bookmarks* *>* *Manage bookmarks Ctrl+Shift+O* *>* *Bookmarks Toolbar* *>* *Organize* *>* *Add bookmark*. From 2bbf50564133e0b18184d7b0c868b834290fb8d9 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Wed, 6 Apr 2022 11:22:23 +0200 Subject: [PATCH 13/26] draft --- modules/end-user-guide/pages/user-onboarding.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/end-user-guide/pages/user-onboarding.adoc b/modules/end-user-guide/pages/user-onboarding.adoc index fff204a27d..dfa6bea3b4 100644 --- a/modules/end-user-guide/pages/user-onboarding.adoc +++ b/modules/end-user-guide/pages/user-onboarding.adoc @@ -13,9 +13,9 @@ If your organization is already running a {prod-short} instance, you can get sta . xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[] . xref:basic-actions-you-can-perform-on-a-workspace.adoc[] -Beyond this, it's likely that your organization has its own onboarding needs regarding: +Beyond this, your organization has its own setup and onboarding needs regarding: * Specific Git repositories -* Devfiles that reside in the specific Git repositories and that are responsible for workspace configuration +* Devfiles that are stored in specific Git repositories and that set workspace configuration * {prod-short} related instructions in the READMEs * Team-level processes and procedures \ No newline at end of file From 6728dfa41d8547ed1518f1b82a4c710f38b2ad1a Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Thu, 7 Apr 2022 11:22:23 +0200 Subject: [PATCH 14/26] draft --- .../pages/basic-actions-you-can-perform-on-a-workspace.adoc | 4 +--- ...-parameters-for-the-urls-for-starting-a-new-workspace.adoc | 4 +++- ...ting-a-new-workspace-with-a-clone-of-a-git-repository.adoc | 4 +++- modules/end-user-guide/pages/user-onboarding.adoc | 2 +- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc b/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc index bbaaaaa8ce..914138e37e 100644 --- a/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc +++ b/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc @@ -30,6 +30,4 @@ After you start a new workspace, you can perform the following actions on it in | _Delete a workspace_ | Go to *⋮* *>* *Delete Workspace*. -|=== - -IMPORTANT: Stopping a workspace preserves its state until it restarts. This is true whether you stop the workspace or it reaches the idle timeout limit or running timeout limit set by your {prod-short} cluster administrator. \ No newline at end of file +|=== \ No newline at end of file diff --git a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc index 88c6c8ef31..51f16a16ad 100644 --- a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc +++ b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc @@ -68,7 +68,9 @@ endif::[] Visiting a URL for starting a new workspace results in a workspace that is based on a combination of a devfile and a linked Git repository. -In some situations, you may need to have multiple workspaces that are duplicates in terms of the devfile and the linked Git repository. You can do this by visiting the same URL for starting a new workspace with a URL parameter. The URL parameter for starting a duplicate workspace is `new`. +In some situations, you may need to have multiple workspaces that are duplicates in terms of the devfile and the linked Git repository. You can do this by visiting the same URL for starting a new workspace with a URL parameter. + +The URL parameter for starting a duplicate workspace is `new`. The URL for starting a new workspace has the following syntax with the `new` parameter: 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 2106b59db7..28e37ba63d 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. So you can have your remote origin or fork cloned into a new starting workspace. Or you can have a common repository of a project cloned into a new starting workspace. With such Git providers as GitHub and GitLab, you can also specify the branch for the new starting workspace to checkout. +With {prod-short}, you can visit a URL in your browser to start a new workspace that contains a clone of a Git repository. Thus you can clone a Git repository that is hosted on GitHub or using a GitLab instance or on a Bitbucket server. So you can have your remote origin or fork cloned into a new starting workspace. Or you can have a common repository of a project cloned into a new starting workspace. With such Git providers as GitHub and GitLab, you can also specify the branch for the new starting workspace to checkout. NOTE: The *Create Workspace* page of your {prod-short} dashboard has the *Git Repo URL ** field as the limited-functionality GUI alternative for entering the URL of a Git repository to start a new workspace. @@ -29,6 +29,8 @@ IMPORTANT: You can also start a new workspace by supplying the URL of a Git repo .Procedure +To start a new workspace with a clone of a Git repository: + . Optional: Visit your {prod-short} dashboard page to authenticate as a {prod-short} user to your organization's instance of {prod-short}. . Visit the URL to start a new workspace using the basic syntax: diff --git a/modules/end-user-guide/pages/user-onboarding.adoc b/modules/end-user-guide/pages/user-onboarding.adoc index dfa6bea3b4..5fa6223408 100644 --- a/modules/end-user-guide/pages/user-onboarding.adoc +++ b/modules/end-user-guide/pages/user-onboarding.adoc @@ -13,7 +13,7 @@ If your organization is already running a {prod-short} instance, you can get sta . xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[] . xref:basic-actions-you-can-perform-on-a-workspace.adoc[] -Beyond this, your organization has its own setup and onboarding needs regarding: +Beyond this, your organization has its own setup and onboarding needs: * Specific Git repositories * Devfiles that are stored in specific Git repositories and that set workspace configuration From c92f2e341a141cc7e1d771083d100682b49aeada Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Thu, 7 Apr 2022 11:57:02 +0200 Subject: [PATCH 15/26] draft --- ...-the-urls-for-starting-a-new-workspace.adoc | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc index 51f16a16ad..63f2361cea 100644 --- a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc +++ b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc @@ -16,6 +16,24 @@ The URL for starting a new workspace supports concatenation of multiple URL para ---- pass:c,a,q[{prod-url}]#____?____&____&____ ---- +.URL for starting a new workspace with the URL of a Git repository and optional URL parameters +==== +The complete URL for the browser: + +\https://codeready-codeready-workspaces-operator.apps.sandbox-m2.ll9k.p1.openshiftapps.com#https://github.com/che-samples/cpp-hello-world?new&che-editor=che-incubator/intellij-community/latest&devfilePath=tests/testdevfile.yaml + +Explanation of the parts of the URL: + +[source,subs="+quotes,+attributes,+macros"] +---- +\https://codeready-codeready-workspaces-operator.apps.sandbox-m2.ll9k.p1.openshiftapps.com <1> +#https://github.com/che-samples/cpp-hello-world <2> +?new&che-editor=che-incubator/intellij-community/latest&devfilePath=tests/testdevfile.yaml <3> +---- +<1> The pass:c,a,q[{prod-url}] part of the URL. +<2> The URL of the Git repository to be cloned into the new workspace. +<3> Concatenated optional URL parameters. +==== == URL parameter for the workspace IDE From d728d9689ab87c686f4bbe0130084532899639a6 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Thu, 7 Apr 2022 15:37:05 +0200 Subject: [PATCH 16/26] completing revisions after lang and eng reviews --- ...the-urls-for-starting-a-new-workspace.adoc | 27 ++++++++++++++----- ...pace-with-a-clone-of-a-git-repository.adoc | 22 ++++++++++++--- .../end-user-guide/pages/user-onboarding.adoc | 2 +- 3 files changed, 40 insertions(+), 11 deletions(-) diff --git a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc index 63f2361cea..751bb24064 100644 --- a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc +++ b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc @@ -7,32 +7,45 @@ [id="parameters-for-the-urls-for-starting-a-new-workspace_{context}"] = Optional parameters for the URLs for starting a new workspace -When you start a workspace, {prod-short} configures the workspace according to the instructions in the devfile. When you use a URL to start a new workspace, you can append optional parameters to the URL that further configure the workspace. You can use these parameters to specify a workspace IDE, start duplicate workspaces, and specify a devfile file name or path. +When you start a new workspace, {prod-short} configures the workspace according to the instructions in the devfile. When you use a URL to start a new workspace, you can append optional parameters to the URL that further configure the workspace. You can use these parameters to specify a workspace IDE, start duplicate workspaces, and specify a devfile file name or path. == URL parameter concatenation -The URL for starting a new workspace supports concatenation of multiple URL parameters by using `&` with the following URL syntax: +The URL for starting a new workspace supports concatenation of multiple optional URL parameters by using `&` with the following URL syntax: + [source,subs="+quotes,+attributes,+macros"] ---- pass:c,a,q[{prod-url}]#____?____&____&____ ---- -.URL for starting a new workspace with the URL of a Git repository and optional URL parameters + +.A URL for starting a new workspace with the URL of a Git repository and optional URL parameters ==== The complete URL for the browser: +ifeval::["{project-context}" == "crw"] \https://codeready-codeready-workspaces-operator.apps.sandbox-m2.ll9k.p1.openshiftapps.com#https://github.com/che-samples/cpp-hello-world?new&che-editor=che-incubator/intellij-community/latest&devfilePath=tests/testdevfile.yaml +endif::[] + +ifeval::["{project-context}" == "che"] +\https://che-openshift-operators.apps.ci-ln-yp1cppt-72292.origin-ci-int-gce.dev.rhcloud.com#https://github.com/che-samples/cpp-hello-world?new&che-editor=che-incubator/intellij-community/latest&devfilePath=tests/testdevfile.yaml +endif::[] Explanation of the parts of the URL: [source,subs="+quotes,+attributes,+macros"] ---- +ifeval::["{project-context}" == "che"] +\https://che-openshift-operators.apps.ci-ln-yp1cppt-72292.origin-ci-int-gce.dev.rhcloud.com/ <1> +endif::[] +ifeval::["{project-context}" == "crw"] \https://codeready-codeready-workspaces-operator.apps.sandbox-m2.ll9k.p1.openshiftapps.com <1> +endif::[] #https://github.com/che-samples/cpp-hello-world <2> ?new&che-editor=che-incubator/intellij-community/latest&devfilePath=tests/testdevfile.yaml <3> ---- <1> The pass:c,a,q[{prod-url}] part of the URL. <2> The URL of the Git repository to be cloned into the new workspace. -<3> Concatenated optional URL parameters. +<3> The concatenated optional URL parameters. ==== == URL parameter for the workspace IDE @@ -55,11 +68,11 @@ pass:c,a,q[{prod-url}]#____?che-editor=____ ifeval::["{project-context}" == "che"] | link:https://github.com/eclipse-che/che-theia[Che-Theia] | `eclipse/che-theia/latest` -| When using the `stable` link:https://github.com/che-incubator/chectl/[chectl] channel, this IDE loads as a default in a new workspace without this URL parameter. +| When using the `stable` link:https://github.com/che-incubator/chectl/[chectl] channel, this IDE loads as a default without this URL parameter. | link:https://github.com/eclipse-che/che-theia[Che-Theia] | `eclipse/che-theia/next` -| When using the `next` link:https://github.com/che-incubator/chectl/[chectl] channel, this IDE loads as a default in a new workspace without this URL parameter. +| When using the `next` link:https://github.com/che-incubator/chectl/[chectl] channel, this IDE loads as a default without this URL parameter. endif::[] ifeval::["{project-context}" == "crw"] @@ -84,7 +97,7 @@ endif::[] == URL parameter for starting duplicate workspaces -Visiting a URL for starting a new workspace results in a workspace that is based on a combination of a devfile and a linked Git repository. +Visiting a URL for starting a new workspace results in a new workspace according to the devfile and with a clone of the linked Git repository. In some situations, you may need to have multiple workspaces that are duplicates in terms of the devfile and the linked Git repository. You can do this by visiting the same URL for starting a new workspace with a URL parameter. 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 28e37ba63d..0cdc7a0fd7 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. Thus you can clone a Git repository that is hosted on GitHub or using a GitLab instance or on a Bitbucket server. So you can have your remote origin or fork cloned into a new starting workspace. Or you can have a common repository of a project cloned into a new starting workspace. With such Git providers as GitHub and GitLab, you can also specify the branch for the new starting workspace to checkout. +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. NOTE: The *Create Workspace* page of your {prod-short} dashboard has the *Git Repo URL ** field as the limited-functionality GUI alternative for entering the URL of a Git repository to start a new workspace. @@ -31,7 +31,7 @@ IMPORTANT: You can also start a new workspace by supplying the URL of a Git repo To start a new workspace with a clone of a Git repository: -. Optional: Visit your {prod-short} dashboard page to authenticate as a {prod-short} user to your organization's instance of {prod-short}. +. Optional: Visit your {prod-short} dashboard pages to authenticate to your organization's instance of {prod-short}. . Visit the URL to start a new workspace using the basic syntax: [source,subs="+quotes,+attributes,+macros"] @@ -50,8 +50,24 @@ pass:c,a,q[{prod-url}]#____?____ <1> <1> See xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[]. ==== + -.URL syntax for starting a new workspace that contains a clone of a GitHub-hosted repository +.A URL for starting a new workspace ==== +[source,subs="+quotes,+attributes,+macros"] +---- +ifeval::["{project-context}" == "che"] +\https://che-openshift-operators.apps.ci-ln-yp1cppt-72292.origin-ci-int-gce.dev.rhcloud.com#https://github.com/che-samples/cpp-hello-world +endif::[] +ifeval::["{project-context}" == "crw"] +\https://codeready-codeready-workspaces-operator.apps.sandbox-m2.ll9k.p1.openshiftapps.com#https://github.com/che-samples/cpp-hello-world +endif::[] +---- +==== ++ +.The URL syntax for starting a new workspace with a clone of a GitHub-hosted repository +==== + +With GitHub and GitLab, you can even use the URL of a specific branch of the repository to be cloned: + * `pass:c,a,q[{prod-url}#https://github.com/____/____]` starts a new workspace with a clone of the default branch. * `pass:c,a,q[{prod-url}#https://github.com/____/____/tree/____]` starts a new workspace with a clone of the specified branch. * `pass:c,a,q[{prod-url}#https://github.com/____/____/pull/____]` starts a new workspace with a clone of the branch of the pull request. diff --git a/modules/end-user-guide/pages/user-onboarding.adoc b/modules/end-user-guide/pages/user-onboarding.adoc index 5fa6223408..6bfc737aa3 100644 --- a/modules/end-user-guide/pages/user-onboarding.adoc +++ b/modules/end-user-guide/pages/user-onboarding.adoc @@ -17,5 +17,5 @@ Beyond this, your organization has its own setup and onboarding needs: * Specific Git repositories * Devfiles that are stored in specific Git repositories and that set workspace configuration -* {prod-short} related instructions in the READMEs +* {prod-short}-related instructions in the READMEs * Team-level processes and procedures \ No newline at end of file From 2a53045e39fc422225179d6e6a355053fbfa1368 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Thu, 7 Apr 2022 18:21:41 +0200 Subject: [PATCH 17/26] draft --- ...-parameters-for-the-urls-for-starting-a-new-workspace.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc index 751bb24064..ec1d4acd70 100644 --- a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc +++ b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc @@ -23,11 +23,11 @@ pass:c,a,q[{prod-url}]#____?____&__ Date: Thu, 7 Apr 2022 18:25:52 +0200 Subject: [PATCH 18/26] draft --- ...meters-for-the-urls-for-starting-a-new-workspace.adoc | 5 +---- ...a-new-workspace-with-a-clone-of-a-git-repository.adoc | 9 ++++----- 2 files changed, 5 insertions(+), 9 deletions(-) diff --git a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc index ec1d4acd70..055ce799ac 100644 --- a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc +++ b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc @@ -13,10 +13,7 @@ When you start a new workspace, {prod-short} configures the workspace according The URL for starting a new workspace supports concatenation of multiple optional URL parameters by using `&` with the following URL syntax: -[source,subs="+quotes,+attributes,+macros"] ----- -pass:c,a,q[{prod-url}]#____?____&____&____ ----- +`pass:c,a,q[{prod-url}]#____?____&____&____` .A URL for starting a new workspace with the URL of a Git repository and optional URL parameters ==== 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 0cdc7a0fd7..116dc24dd4 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 @@ -52,15 +52,14 @@ pass:c,a,q[{prod-url}]#____?____ <1> + .A URL for starting a new workspace ==== -[source,subs="+quotes,+attributes,+macros"] ----- + ifeval::["{project-context}" == "che"] -\https://che-openshift-operators.apps.ci-ln-yp1cppt-72292.origin-ci-int-gce.dev.rhcloud.com#https://github.com/che-samples/cpp-hello-world +`\https://che-openshift-operators.apps.ci-ln-yp1cppt-72292.origin-ci-int-gce.dev.rhcloud.com#https://github.com/che-samples/cpp-hello-world` endif::[] ifeval::["{project-context}" == "crw"] -\https://codeready-codeready-workspaces-operator.apps.sandbox-m2.ll9k.p1.openshiftapps.com#https://github.com/che-samples/cpp-hello-world +`\https://codeready-codeready-workspaces-operator.apps.sandbox-m2.ll9k.p1.openshiftapps.com#https://github.com/che-samples/cpp-hello-world` endif::[] ----- + ==== + .The URL syntax for starting a new workspace with a clone of a GitHub-hosted repository From 060558818021a9183f20a7f2060a25b61d1d0e1c Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Fri, 8 Apr 2022 17:22:35 +0200 Subject: [PATCH 19/26] Update modules/end-user-guide/pages/user-onboarding.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- modules/end-user-guide/pages/user-onboarding.adoc | 7 ------- 1 file changed, 7 deletions(-) diff --git a/modules/end-user-guide/pages/user-onboarding.adoc b/modules/end-user-guide/pages/user-onboarding.adoc index 6bfc737aa3..c1f282fc4d 100644 --- a/modules/end-user-guide/pages/user-onboarding.adoc +++ b/modules/end-user-guide/pages/user-onboarding.adoc @@ -12,10 +12,3 @@ If your organization is already running a {prod-short} instance, you can get sta . xref:starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc[] . xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[] . xref:basic-actions-you-can-perform-on-a-workspace.adoc[] - -Beyond this, your organization has its own setup and onboarding needs: - -* Specific Git repositories -* Devfiles that are stored in specific Git repositories and that set workspace configuration -* {prod-short}-related instructions in the READMEs -* Team-level processes and procedures \ No newline at end of file From 90e1ccc7d97024a6e53121bb1febf5a13103b7a0 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Fri, 8 Apr 2022 17:27:11 +0200 Subject: [PATCH 20/26] Update modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- ...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 116dc24dd4..27874249e7 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 @@ -24,7 +24,7 @@ NOTE: The *Create Workspace* page of your {prod-short} dashboard has the *Git Re * The administrator of your organization's {prod-short} instance or the repository maintainer or the README author has provided you with the URL of your organization's {prod-short} instance that you need as a user to access your {prod-short} dashboard pages and start and manage your workspaces. This URL is a fully qualified domain name (FQDN): `pass:c,a,q[{prod-url}]`. * Your Git repository maintainer keeps the `devfile.yaml` or `.devfile.yaml` file in the root directory of the Git repository. (For alternative file names and file paths, see xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[].) + -IMPORTANT: You can also start a new workspace by supplying the URL of a Git repository that contains no devfile. Doing so results in a workspace with the Che-Theia IDE and the Universal Developer Image. +TIP: You can also start a new workspace by supplying the URL of a Git repository that contains no devfile. Doing so results in a workspace with the Che-Theia IDE and the Universal Developer Image. //provide xrefs to a concept module about the Universal Developer Image and, if applicable, devfile-less defaults for new workspaces. max-cx .Procedure From cab5d832780b42ad70bac9712d78abde425a307b Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Fri, 8 Apr 2022 17:27:51 +0200 Subject: [PATCH 21/26] Update modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- ...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 27874249e7..0bd77d5fce 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 @@ -25,7 +25,7 @@ NOTE: The *Create Workspace* page of your {prod-short} dashboard has the *Git Re * Your Git repository maintainer keeps the `devfile.yaml` or `.devfile.yaml` file in the root directory of the Git repository. (For alternative file names and file paths, see xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[].) + TIP: You can also start a new workspace by supplying the URL of a Git repository that contains no devfile. Doing so results in a workspace with the Che-Theia IDE and the Universal Developer Image. -//provide xrefs to a concept module about the Universal Developer Image and, if applicable, devfile-less defaults for new workspaces. max-cx +//provide a link to a page about the Universal Developer Image similar to https://developers.redhat.com/products/rhel/ubi for UBI and, if applicable, devfile-less defaults for new workspaces. max-cx .Procedure From c483fe0deb200b2b315d521bfff671537e72b519 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Fri, 8 Apr 2022 17:31:20 +0200 Subject: [PATCH 22/26] Update modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- ...al-parameters-for-the-urls-for-starting-a-new-workspace.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc index 055ce799ac..7931c3d30b 100644 --- a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc +++ b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc @@ -47,7 +47,7 @@ endif::[] == URL parameter for the workspace IDE -Che-Theia is currently the default integrated development environment (IDE) that a workspace loads with if no IDE is specified as a URL parameter as part of the URL for starting a new workspace. +Che-Theia is the default integrated development environment (IDE) that a workspace loads with if no IDE is specified as a URL parameter as part of the URL for starting a new workspace. The URL parameter for specifying another supported IDE is `che-editor=____`. From 4d0906d76f459a27988ecfc28d81f2441f311f1f Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Fri, 8 Apr 2022 18:29:56 +0200 Subject: [PATCH 23/26] draft --- ...c-actions-you-can-perform-on-a-workspace.adoc | 2 +- ...or-the-urls-for-starting-a-new-workspace.adoc | 16 ++++++---------- ...rkspace-with-a-clone-of-a-git-repository.adoc | 2 +- 3 files changed, 8 insertions(+), 12 deletions(-) diff --git a/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc b/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc index 914138e37e..674d319950 100644 --- a/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc +++ b/modules/end-user-guide/pages/basic-actions-you-can-perform-on-a-workspace.adoc @@ -1,6 +1,6 @@ :_content-type: REFERENCE :description: Basic actions you can perform on a workspace -:keywords: running-workspace, stopped-workspace, open-workspace, open-a-workspace, open-a-running-workspace, opening-workspace, opening-a-workspace, opening-a-running-workspace, how-to-open-workspace, how-to-open-a-workspace, how-to-open-a-running-workspace, reopen-workspace, reopen-a-workspace, reopen-a-running-workspace, reopening-workspace, reopening-a-workspace, reopening-a-running-workspace, how-to-reopen-workspace, how-to-reopen-a-workspace, how-to-reopen-a-running-workspace, restart-workspace, restart-a-workspace, restart-a-running-workspace, restarting-workspace, restarting-a-workspace, restarting-a-running-workspace, how-to-restart-workspace, how-to-restart-a-workspace, how-to-restart-a-running-workspace, stop-workspace, stop-a-workspace, stop-a-running-workspace, stopping-workspace, stopping-a-workspace, stopping-a-running-workspace, how-to-stop-workspace, how-to-stop-a-workspace, how-to-stop-a-running-workspace, start-workspace, start-a-workspace, start-stopped-workspace, start-a-stopped-workspace, starting-workspace, starting-a-workspace, starting-stopped-workspace, starting-a-stopped-workspace, how-to-start-workspace, how-to-start-a-workspace, how-to-start-stopped-workspace, how-to-start-a-stopped-workspace, delete-workspace, delete-a-workspace, deleting-workspace, deleting-a-workspace, how-to-delete-workspace, how-to-delete-a-workspace +:keywords: workspace, workspaces, reopen, restart, stop, start, delete :navtitle: Basic actions you can perform on a workspace // :page-aliases: diff --git a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc index 7931c3d30b..afa7a360dd 100644 --- a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc +++ b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc @@ -49,9 +49,7 @@ endif::[] Che-Theia is the default integrated development environment (IDE) that a workspace loads with if no IDE is specified as a URL parameter as part of the URL for starting a new workspace. -The URL parameter for specifying another supported IDE is `che-editor=____`. - -The URL for starting a new workspace has the following syntax with the `che-editor=____` parameter: +The URL parameter for specifying another supported IDE is `che-editor=____`: [source,subs="+quotes,+attributes,+macros"] ---- @@ -98,9 +96,7 @@ Visiting a URL for starting a new workspace results in a new workspace according In some situations, you may need to have multiple workspaces that are duplicates in terms of the devfile and the linked Git repository. You can do this by visiting the same URL for starting a new workspace with a URL parameter. -The URL parameter for starting a duplicate workspace is `new`. - -The URL for starting a new workspace has the following syntax with the `new` parameter: +The URL parameter for starting a duplicate workspace is `new`: [source,subs="+quotes,+attributes,+macros"] ---- @@ -113,9 +109,9 @@ NOTE: If you currently have a workspace that you started using a URL, then visit When you visit a URL for starting a new workspace, {prod-short} searches the linked Git repository for a devfile with the file name `.devfile.yaml` or `devfile.yaml`. The devfile in the linked Git repository must follow this file-naming convention. -In some situations, you may need to specify a different, unconventional file name for the devfile. The URL parameter for specifying an unconventional file name of the devfile is `df=____.yaml`. +In some situations, you may need to specify a different, unconventional file name for the devfile. -The URL for starting a new workspace has the following syntax with the `df=____.yaml` parameter: +The URL parameter for specifying an unconventional file name of the devfile is `df=____.yaml`: [source,subs="+quotes,+attributes,+macros"] ---- @@ -129,9 +125,9 @@ TIP: The `df=____.yaml` parameter also has a long version: `devfilePat When you visit a URL for starting a new workspace, {prod-short} searches the root directory of the linked Git repository for a devfile (with the file name `.devfile.yaml` or `devfile.yaml`). The file path of the devfile in the linked Git repository must follow this path convention. -In some situations, you may need to specify a different, unconventional file path for the devfile in the linked Git repository. The URL parameter for specifying an unconventional file path of the devfile is `devfilePath=____`. +In some situations, you may need to specify a different, unconventional file path for the devfile in the linked Git repository. -The URL for starting a new workspace has the following syntax with the `devfilePath=____` parameter: +The URL parameter for specifying an unconventional file path of the devfile is `devfilePath=____`: [source,subs="+quotes,+attributes,+macros"] ---- 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 0bd77d5fce..63f180942a 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 @@ -21,7 +21,7 @@ NOTE: The *Create Workspace* page of your {prod-short} dashboard has the *Git Re .Prerequisites * Your organization has a running instance of {prod-short}. -* The administrator of your organization's {prod-short} instance or the repository maintainer or the README author has provided you with the URL of your organization's {prod-short} instance that you need as a user to access your {prod-short} dashboard pages and start and manage your workspaces. This URL is a fully qualified domain name (FQDN): `pass:c,a,q[{prod-url}]`. +* You know the FQDN URL of your organization's {prod-short} instance: `pass:c,a,q[{prod-url}]`. * Your Git repository maintainer keeps the `devfile.yaml` or `.devfile.yaml` file in the root directory of the Git repository. (For alternative file names and file paths, see xref:optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc[].) + TIP: You can also start a new workspace by supplying the URL of a Git repository that contains no devfile. Doing so results in a workspace with the Che-Theia IDE and the Universal Developer Image. From 637bcb6b417fa1a4fd03d7deb7d231efd0099a8a Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Fri, 8 Apr 2022 18:30:14 +0200 Subject: [PATCH 24/26] Update modules/end-user-guide/pages/starting-a-new-workspace-with-a-clone-of-a-git-repository.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- ...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 63f180942a..f36edefb2e 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 @@ -16,7 +16,7 @@ Working with {prod-short} in your browser involves multiple URLs: 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. -NOTE: The *Create Workspace* page of your {prod-short} dashboard has the *Git Repo URL ** field as the limited-functionality GUI alternative for entering the URL of a Git repository to start a new workspace. +NOTE: 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. .Prerequisites From 3740d24c39c214fb700144a607ce85f0eac0755f Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Fri, 8 Apr 2022 18:39:37 +0200 Subject: [PATCH 25/26] replaced one word --- ...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 f36edefb2e..c241d2de28 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 @@ -74,7 +74,7 @@ With GitHub and GitLab, you can even use the URL of a specific branch of the rep + After you enter the URL to start a new workspace in a browser tab, it renders the workspace-starting page. + -When the new workspace is ready, the workspace GUI loads in the browser tab. +When the new workspace is ready, the workspace IDE loads in the browser tab. + A clone of the Git repository is present in the filesystem of the new workspace. + From 6c788886a5bea3026c8f7c1a99e8a73f96f35239 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Wed, 13 Apr 2022 11:47:57 +0200 Subject: [PATCH 26/26] fix --- ...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 c241d2de28..d5c2b3df49 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 @@ -16,7 +16,7 @@ Working with {prod-short} in your browser involves multiple URLs: 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. -NOTE: 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. +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. .Prerequisites