Skip to content

Commit 5fefd2d

Browse files
chore: Add a URL parameter for the existing workspace name (#2922)
* chore: Add a URL parameter for the existing workspace name Signed-off-by: Oleksii Orel <oorel@redhat.com> Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com>
1 parent a41c688 commit 5fefd2d

4 files changed

+47
-1
lines changed

modules/end-user-guide/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
**** xref:url-parameter-for-container-image.adoc[]
1515
**** xref:url-parameter-for-memory-limit.adoc[]
1616
**** xref:url-parameter-for-cpu-limit.adoc[]
17+
**** xref:url-parameter-for-the-existing-workspace-name.adoc[]
1718
** xref:starting-a-workspace-from-a-raw-devfile-url.adoc[]
1819
** xref:basic-actions-you-can-perform-on-a-workspace.adoc[]
1920
** xref:authenticating-to-a-git-server-from-a-workspace.adoc[]

modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,4 @@ When you start a new workspace, {prod-short} configures the workspace according
2020
* xref:url-parameter-for-container-image.adoc[]
2121
* xref:url-parameter-for-memory-limit.adoc[]
2222
* xref:url-parameter-for-cpu-limit.adoc[]
23+
* xref:url-parameter-for-the-existing-workspace-name.adoc[]

modules/end-user-guide/pages/url-parameter-for-starting-duplicate-workspaces.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,7 @@ The URL parameter for starting a duplicate workspace is `new`:
1818
pass:c,a,q[{prod-url}]#__<git_repository_url>__?new
1919
----
2020

21-
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.
21+
[NOTE]
22+
====
23+
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.
24+
====
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
:_content-type: CONCEPT
2+
:description: URL parameter for the existing workspace name
3+
:keywords: existing-workspace-name, how-to-start-workspace
4+
:navtitle: URL parameter for the existing workspace name
5+
:page-aliases:
6+
7+
[id="url-parameter-for-the-existing-workspace-name"]
8+
= URL parameter for the existing workspace name
9+
10+
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.
11+
12+
.Example
13+
14+
====
15+
16+
`pass:c,a,q[{prod-url}]#<git_repository_url>?existing=workspace_name`
17+
18+
====
19+
20+
When specifying the `existing` URL parameter, following situations may arise:
21+
22+
* If there is no workspace created from the same URL, a new workspace is created.
23+
24+
* If the specified existing workspace name matches an existing workspace created from the same URL and the existing workspace is opened.
25+
26+
* 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:
27+
** Create a new workspace.
28+
** Select an existing workspace to open.
29+
30+
[NOTE]
31+
====
32+
To create multiple workspaces from the same URL, you can use the `new` URL parameter:
33+
[source,subs="+quotes,+attributes,+macros"]
34+
----
35+
pass:c,a,q[{prod-url}]#__<git_repository_url>__?new
36+
----
37+
====
38+
39+
.Additional resources
40+
41+
* xref:url-parameter-for-starting-duplicate-workspaces.adoc[]

0 commit comments

Comments
 (0)