diff --git a/modules/end-user-guide/nav.adoc b/modules/end-user-guide/nav.adoc index e214f445d4..56a0d989e7 100644 --- a/modules/end-user-guide/nav.adoc +++ b/modules/end-user-guide/nav.adoc @@ -14,6 +14,7 @@ **** xref:url-parameter-for-container-image.adoc[] **** xref:url-parameter-for-memory-limit.adoc[] **** xref:url-parameter-for-cpu-limit.adoc[] +**** xref:url-parameter-for-the-existing-workspace-name.adoc[] ** xref:starting-a-workspace-from-a-raw-devfile-url.adoc[] ** xref:basic-actions-you-can-perform-on-a-workspace.adoc[] ** xref:authenticating-to-a-git-server-from-a-workspace.adoc[] 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 f3b98432ed..21d2ae1445 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 @@ -20,3 +20,4 @@ When you start a new workspace, {prod-short} configures the workspace according * xref:url-parameter-for-container-image.adoc[] * xref:url-parameter-for-memory-limit.adoc[] * xref:url-parameter-for-cpu-limit.adoc[] +* xref:url-parameter-for-the-existing-workspace-name.adoc[] diff --git a/modules/end-user-guide/pages/url-parameter-for-starting-duplicate-workspaces.adoc b/modules/end-user-guide/pages/url-parameter-for-starting-duplicate-workspaces.adoc index cc1509c29d..3ff9838fee 100644 --- a/modules/end-user-guide/pages/url-parameter-for-starting-duplicate-workspaces.adoc +++ b/modules/end-user-guide/pages/url-parameter-for-starting-duplicate-workspaces.adoc @@ -18,4 +18,7 @@ The URL parameter for starting a duplicate workspace is `new`: pass:c,a,q[{prod-url}]#____?new ---- -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. +[NOTE] +==== +If you currently have a workspace that you started by using a URL, then visiting the URL again without the `new` URL parameter opens the existing workspace. +==== diff --git a/modules/end-user-guide/pages/url-parameter-for-the-existing-workspace-name.adoc b/modules/end-user-guide/pages/url-parameter-for-the-existing-workspace-name.adoc new file mode 100644 index 0000000000..efc34cdf48 --- /dev/null +++ b/modules/end-user-guide/pages/url-parameter-for-the-existing-workspace-name.adoc @@ -0,0 +1,41 @@ +:_content-type: CONCEPT +:description: URL parameter for the existing workspace name +:keywords: existing-workspace-name, how-to-start-workspace +:navtitle: URL parameter for the existing workspace name +:page-aliases: + +[id="url-parameter-for-the-existing-workspace-name"] += URL parameter for the existing workspace name + +If you start a new workspace with a URL that contains the `existing` URL parameter specifying an existing workspace name, the existing workspace created from the same URL is opened. + +.Example + +==== + +`pass:c,a,q[{prod-url}]#?existing=workspace_name` + +==== + +When specifying the `existing` URL parameter, following situations may arise: + +* If there is no workspace created from the same URL, a new workspace is created. + +* If the specified existing workspace name matches an existing workspace created from the same URL and the existing workspace is opened. + +* If the specified existing workspace name does not match any existing workspaces, a warning appears and you need to select one of the following actions: + ** Create a new workspace. + ** Select an existing workspace to open. + +[NOTE] +==== +To create multiple workspaces from the same URL, you can use the `new` URL parameter: +[source,subs="+quotes,+attributes,+macros"] +---- +pass:c,a,q[{prod-url}]#____?new +---- +==== + +.Additional resources + +* xref:url-parameter-for-starting-duplicate-workspaces.adoc[]