From 31b6f0c829e68655a8745f96c36e79512cfd29b8 Mon Sep 17 00:00:00 2001 From: Jiachen Jiang Date: Wed, 10 Dec 2025 11:07:14 -0800 Subject: [PATCH 1/9] first draft of shared workspaces page --- docs/user-guides/workspaces-shared.md | 62 +++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 docs/user-guides/workspaces-shared.md diff --git a/docs/user-guides/workspaces-shared.md b/docs/user-guides/workspaces-shared.md new file mode 100644 index 0000000000000..d10d176cbed13 --- /dev/null +++ b/docs/user-guides/workspaces-shared.md @@ -0,0 +1,62 @@ +# Shared Workspaces + +Multiple users can securely connect to a single Coder workspace for debugging, programming, and code review. + +(Insert screenshot of UI here) + +## Features + +Workspace sharing is available to all Coder users by default, but platform admins with a Premium subscription can choose to disable sharing within their organizations. + +Owners of a workspace can grant access to other users or groups with scoped roles. + +This is helpful in a number of scenarios, including: + +- Developers can do ad-hoc debugging, pair programming, and code reviews. +- A workspace can be owned by a group of users for QA, on-call rotations, or shared staging. +- AI workflows where an agent prepares a workspace and a developer takes over to review or finalize the work (ex. with [Coder Tasks](https://coder.com/docs/ai-coder/tasks).) + +## Getting Started + +Workspaces can be shared through either the Coder CLI or UI. + +Before you begin, ensure that you have a version of Coder with workspace sharing enabled and that your account has permission to share workspaces. This is true by default if you are an OSS user, but Premium users are subject to organization-specific restrictions. + +### CLI + +To share a workspace: +- `coder sharing share --user alice` + - Shares the workspace with a single user, `alice`, with `use` permissions +- `coder sharing share --user alice:admin,bob` + - Shares the workspace with two users - `alice` with `admin` permissions, and `bob` with `use` permissions +- `coder sharing share --group contractor` + - Shares the workspace with `contractor`, which is a group of users + +To remove sharing from a workspace: +- `coder sharing remove --user alice` + - Workspace is no longer shared with the user `alice`. +- `coder sharing remove --group contractor` + - Workspace is no longer shared with the group `contractor`. + +To show who a workspace is shared with: +- `coder sharing show ` + +To list shared workspaces: +- `coder list --shared` +- `coder list --search shared_with_user:` +- `coder list --search shared_with_group:` + +### UI + +1. Open a workspace that you own. +2. Locate and click the 'Share' button. + +(Add screenshot of where the button is located in the UI) + +3. Add the users or groups that you want to share the workspace with. For each one, select a role. + - `use` allows for connection via SSH and apps, the ability to start and stop the workspace, view logs and stats, and update on start when required. + - `admin` allows for all of the above, as well as the ability to rename the workspace, update at any time, and invite others with the `use` role. + - Neither role allows for the user to delete the workspace. + +4. Confirm changes and notify your collaborators. + From 81ecf0eeb43de617910ba68811ee9f88ee73a0cb Mon Sep 17 00:00:00 2001 From: Jiachen Jiang Date: Wed, 10 Dec 2025 13:09:28 -0800 Subject: [PATCH 2/9] Update docs/user-guides/workspaces-shared.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: ケイラ --- docs/user-guides/workspaces-shared.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guides/workspaces-shared.md b/docs/user-guides/workspaces-shared.md index d10d176cbed13..f961d29523976 100644 --- a/docs/user-guides/workspaces-shared.md +++ b/docs/user-guides/workspaces-shared.md @@ -6,7 +6,7 @@ Multiple users can securely connect to a single Coder workspace for debugging, p ## Features -Workspace sharing is available to all Coder users by default, but platform admins with a Premium subscription can choose to disable sharing within their organizations. +Workspace sharing is available to all Coder users by default, but platform admins with a Premium subscription can choose to disable sharing within their organizations or for their entire deployment. Owners of a workspace can grant access to other users or groups with scoped roles. From 85ac5946f75fa5e01e949bd67668dc89e230cee2 Mon Sep 17 00:00:00 2001 From: Jiachen Jiang Date: Wed, 10 Dec 2025 13:09:36 -0800 Subject: [PATCH 3/9] Update docs/user-guides/workspaces-shared.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: ケイラ --- docs/user-guides/workspaces-shared.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guides/workspaces-shared.md b/docs/user-guides/workspaces-shared.md index f961d29523976..2977bc1f48032 100644 --- a/docs/user-guides/workspaces-shared.md +++ b/docs/user-guides/workspaces-shared.md @@ -12,7 +12,7 @@ Owners of a workspace can grant access to other users or groups with scoped role This is helpful in a number of scenarios, including: -- Developers can do ad-hoc debugging, pair programming, and code reviews. +- Developers can do ad-hoc debugging or pair programming. - A workspace can be owned by a group of users for QA, on-call rotations, or shared staging. - AI workflows where an agent prepares a workspace and a developer takes over to review or finalize the work (ex. with [Coder Tasks](https://coder.com/docs/ai-coder/tasks).) From 55fa18cdadafdadc15882775eb3d762ed3cf5510 Mon Sep 17 00:00:00 2001 From: Jiachen Jiang Date: Wed, 10 Dec 2025 13:09:44 -0800 Subject: [PATCH 4/9] Update docs/user-guides/workspaces-shared.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: ケイラ --- docs/user-guides/workspaces-shared.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guides/workspaces-shared.md b/docs/user-guides/workspaces-shared.md index 2977bc1f48032..01671badb3c07 100644 --- a/docs/user-guides/workspaces-shared.md +++ b/docs/user-guides/workspaces-shared.md @@ -2,7 +2,7 @@ Multiple users can securely connect to a single Coder workspace for debugging, programming, and code review. -(Insert screenshot of UI here) + ## Features From beb5adb1b4c75b4a6ac18b0fca2e654cb075a2a7 Mon Sep 17 00:00:00 2001 From: Jiachen Jiang Date: Wed, 10 Dec 2025 13:09:56 -0800 Subject: [PATCH 5/9] Update docs/user-guides/workspaces-shared.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: ケイラ --- docs/user-guides/workspaces-shared.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/user-guides/workspaces-shared.md b/docs/user-guides/workspaces-shared.md index 01671badb3c07..2565d8499532f 100644 --- a/docs/user-guides/workspaces-shared.md +++ b/docs/user-guides/workspaces-shared.md @@ -58,5 +58,4 @@ To list shared workspaces: - `admin` allows for all of the above, as well as the ability to rename the workspace, update at any time, and invite others with the `use` role. - Neither role allows for the user to delete the workspace. -4. Confirm changes and notify your collaborators. From a1450ae86e470484c92bbd59adb24b8b47a39afc Mon Sep 17 00:00:00 2001 From: Jiachen Jiang Date: Wed, 10 Dec 2025 13:10:05 -0800 Subject: [PATCH 6/9] Update docs/user-guides/workspaces-shared.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: ケイラ --- docs/user-guides/workspaces-shared.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guides/workspaces-shared.md b/docs/user-guides/workspaces-shared.md index 2565d8499532f..5a96d3649c58b 100644 --- a/docs/user-guides/workspaces-shared.md +++ b/docs/user-guides/workspaces-shared.md @@ -20,7 +20,7 @@ This is helpful in a number of scenarios, including: Workspaces can be shared through either the Coder CLI or UI. -Before you begin, ensure that you have a version of Coder with workspace sharing enabled and that your account has permission to share workspaces. This is true by default if you are an OSS user, but Premium users are subject to organization-specific restrictions. +Before you begin, ensure that you have a version of Coder with workspace sharing enabled and that your account has permission to share workspaces. This is true by default if you are an OSS user, but deployments with Premium licenses may be restricted by admins. ### CLI From 3b661d2e9ef1c06b8022f0a4f1faf7a80855ff55 Mon Sep 17 00:00:00 2001 From: Jiachen Jiang Date: Wed, 10 Dec 2025 13:10:14 -0800 Subject: [PATCH 7/9] Update docs/user-guides/workspaces-shared.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: ケイラ --- docs/user-guides/workspaces-shared.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guides/workspaces-shared.md b/docs/user-guides/workspaces-shared.md index 5a96d3649c58b..ea11b9f3c5974 100644 --- a/docs/user-guides/workspaces-shared.md +++ b/docs/user-guides/workspaces-shared.md @@ -51,7 +51,7 @@ To list shared workspaces: 1. Open a workspace that you own. 2. Locate and click the 'Share' button. -(Add screenshot of where the button is located in the UI) + 3. Add the users or groups that you want to share the workspace with. For each one, select a role. - `use` allows for connection via SSH and apps, the ability to start and stop the workspace, view logs and stats, and update on start when required. From 589a65169d19026d5794991c8153000bf89b1b2c Mon Sep 17 00:00:00 2001 From: Jiachen Jiang Date: Thu, 11 Dec 2025 09:52:12 -0800 Subject: [PATCH 8/9] added beta tag --- docs/manifest.json | 7 +++++++ docs/user-guides/workspaces-shared.md | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/manifest.json b/docs/manifest.json index 709d67e2ca24c..137e03caa8f70 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -308,6 +308,13 @@ "path": "./user-guides/workspace-management.md", "icon_path": "./images/icons/generic.svg" }, + { + "title": "Workspace Sharing", + "description": "Sharing workspaces", + "path": "./user-guides/workspace-shared.md", + "icon_path": "./images/icons/generic.svg", + "state": ["beta"] + }, { "title": "Workspace Scheduling", "description": "Cost control with workspace schedules", diff --git a/docs/user-guides/workspaces-shared.md b/docs/user-guides/workspaces-shared.md index ea11b9f3c5974..200c42467bd47 100644 --- a/docs/user-guides/workspaces-shared.md +++ b/docs/user-guides/workspaces-shared.md @@ -1,6 +1,6 @@ # Shared Workspaces -Multiple users can securely connect to a single Coder workspace for debugging, programming, and code review. +Multiple users can securely connect to a single Coder workspace for programming and debugging. From adc795d36397575f4e7482845ee7ae86f0cd3b7e Mon Sep 17 00:00:00 2001 From: Jiachen Jiang Date: Fri, 12 Dec 2025 07:46:58 -0800 Subject: [PATCH 9/9] changed file names --- docs/manifest.json | 2 +- docs/user-guides/{workspaces-shared.md => shared-workspaces.md} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/user-guides/{workspaces-shared.md => shared-workspaces.md} (100%) diff --git a/docs/manifest.json b/docs/manifest.json index 137e03caa8f70..b096ed0b5d736 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -311,7 +311,7 @@ { "title": "Workspace Sharing", "description": "Sharing workspaces", - "path": "./user-guides/workspace-shared.md", + "path": "./user-guides/shared-workspaces.md", "icon_path": "./images/icons/generic.svg", "state": ["beta"] }, diff --git a/docs/user-guides/workspaces-shared.md b/docs/user-guides/shared-workspaces.md similarity index 100% rename from docs/user-guides/workspaces-shared.md rename to docs/user-guides/shared-workspaces.md