chore: Add a URL parameter for the existing workspace name #2922
Conversation
Signed-off-by: Oleksii Orel <oorel@redhat.com>
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
|
🎊 Navigate the preview: https://686540b38bc78e5542016e67--eclipse-che-docs-pr.netlify.app 🎊 |
|
please add the document to the end user nav.adoc |
Signed-off-by: Oleksii Orel <oorel@redhat.com>
modules/end-user-guide/pages/url-parameter-for-starting-duplicate-workspaces.adoc
Outdated
Show resolved
Hide resolved
| = URL parameter for the existing workspace name | ||
|
|
||
| If the URL for starting a new workspace contain a URL parameter specifying the existing workspace name, | ||
| an existing workspace created from the same URL is opened, or a new workspace is created. |
There was a problem hiding this comment.
to understand this sentence better: in which case is a new workspace created with the existing URL parameter?
There was a problem hiding this comment.
A new workspace is created with the existing URL parameter if no workspaces with the same repository URL already exist.
There was a problem hiding this comment.
We need the existing URL parameter to prioritize opening workspaces when multiple workspaces are created from the same URL.
There was a problem hiding this comment.
I see. thanks for the explanation, I re-worded the sentence a bit. I'm wondering if there's a way to rewrite "The specified existing workspace name will be preferred " to make it more clear what's going to happen. does it mean that the workspace with the existing parameter will open instead of the others?
…ate-workspaces.adoc Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com>
| an existing workspace created from the same URL is opened, or a new workspace is created. | ||
| The specified existing workspace name will be preferred if multiple workspaces were created from the same URL. | ||
|
|
||
| The URL parameter for the existing workspace name is `existing=`: |
There was a problem hiding this comment.
@olexii4
could you please document the case when the name is not set or workspace with this name doesn't exist.
Examples:
1. `pass:c,a,q[{prod-url}]#<git_repository_url>?existing`
2. `pass:c,a,q[{prod-url}]#<git_repository_url>?existing=workspace-doesnt-exist`
| 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. |
There was a problem hiding this comment.
Could you please add an example like
pass:c,a,q[{prod-url}]#<git_repository_url>?new
|
|
||
| ==== | ||
|
|
||
| `pass:c,a,q[{prod-url}]#https://github.com/eclipse-che/che-docs?existing=che-docs` |
There was a problem hiding this comment.
@deerskindoll I think it should be good, because it's just an example, but to double check: would it be OK if we have che related link in the DevSpaces documentation ?
There was a problem hiding this comment.
good catch! we shouldn't do that. we need separate example for Dev Spaces or a neutral example applicable for both.
There was a problem hiding this comment.
I think it could be replaced with
pass:c,a,q[{prod-url}]#<git_repository_url>?existing=workspace_name
| If the URL for starting a new workspace contain a URL parameter specifying the existing workspace name, | ||
| an existing workspace created from the same URL is opened, or a new workspace is created. | ||
| The specified existing workspace name will be preferred if multiple workspaces were created from the same URL. |
There was a problem hiding this comment.
| If the URL for starting a new workspace contain a URL parameter specifying the existing workspace name, | |
| an existing workspace created from the same URL is opened, or a new workspace is created. | |
| The specified existing workspace name will be preferred if multiple workspaces were created from the same URL. | |
| 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. If no workspace from the same URL exists yet, a new workspace is created. | |
| [NOTE] | |
| ==== | |
| If you create multiple workspaces from the same URL, the specified existing workspace name will be preferred. | |
| ==== |
What does this pull request change?
This PR adds a URL parameter for the existing workspace name.
What issues does this pull request fix or reference?
need for eclipse-che/che#23402
Specify the version of the product this pull request applies to
DS 3.23
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.