Skip to content

Commit

Permalink
Add documentation for workspace privacy
Browse files Browse the repository at this point in the history 
Signed-off-by: Kapian1234 <[email protected]>
  • Loading branch information
@Kapian1234
Kapian1234 committed Jan 2, 2025
1 parent ca2e7f4 commit a244b07
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions _dashboards/workspace/workspace-acl.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,3 +151,38 @@ To remove several collaborators simultaneously, follow these steps:
2. Select the **Delete x collaborators** button.
3. Review the confirmation modal that appears.
4. Select **Confirm** to remove all selected collaborators from the table.

## Workspace privacy

**Workspace Privacy** allows quick configuration of access permissions for all users. Only **workspace administrators** can set workspace privacy. As with the collaborators feature, **Workspace Privacy** is only available when permission control is enabled. Workspace privacy can be configured with the following three access levels:

* **Private to collaborators (default access level):** Only collaborators can access the workspace.
* **Anyone can view:** Anyone can view workspace assets. (Grants **Read only** permission to all users.)
* **Anyone can edit:** Anyone can view, create, and update workspace assets. (Grants **Read and write** permission to all users.)

A collaborator will be granted the higher permissions when their individual access level differs from the workspace privacy. For example, if workspace privacy is set to "Anyone can edit", any collaborator with read-only access level will also be able to edit the workspace assets.

### Configuring workspace privacy

You can set up workspace privacy on the **Create Workspace** page as a **Dashboard admin**. You can also modify it on the **Collaborators** and **Workspace details** pages as a **Workspace admin** or **Dashboard admin**.

#### Setting up workspace privacy during workspace creation

1. Complete entering the workspace name, selecting use case, and associating data sources. See [Create a workspace]({{site.url}}{{site.baseurl}}/dashboards/workspace/create-workspace) for instructions.

Check failure on line 171 in _dashboards/workspace/workspace-acl.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/dashboards/workspace/create-workspace)'.

Raw Output:
{"message": "[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/dashboards/workspace/create-workspace)'.", "location": {"path": "_dashboards/workspace/workspace-acl.md", "range": {"start": {"line": 171, "column": 116}}}, "severity": "ERROR"}
2. Choose the desired access level from the cards at the **Set up privacy** panel. (**Private to collaborators** is set as the default selection.)
3. Decide whether to continue configuring collaborators after workspace creation by selecting the **Go to configure the collaborators right after creating the workspace.** checkbox below.

Check warning on line 173 in _dashboards/workspace/workspace-acl.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.DirectionAboveBelow] Use 'following or later' instead of 'below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.

Raw Output:
{"message": "[OpenSearch.DirectionAboveBelow] Use 'following or later' instead of 'below' for versions or orientation within a document. Use 'above' and 'below' only for physical space or screen descriptions.", "location": {"path": "_dashboards/workspace/workspace-acl.md", "range": {"start": {"line": 173, "column": 182}}}, "severity": "WARNING"}
4. Select **Create workspace** to finish the workspace creation.

#### Modifying workspace privacy on the Collaborators page

1. Select the **Edit** next to **Workspace privacy**.
2. Click the selector which displays the current workspace privacy access level.
3. Select the new access level from the dropdown list.
4. Select **Save changes** to apply the modifications.

#### Modifying workspace privacy on the Workspace details page

1. Select the **Edit** button at the top-right corner of the **Details** panel.

Check warning on line 185 in _dashboards/workspace/workspace-acl.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.DirectionTopBottom] Use 'upper-right' instead of 'top-right' for window, page, or pane references to features or controls. Use 'top' and 'bottom' only as a general screen reference.

Raw Output:
{"message": "[OpenSearch.DirectionTopBottom] Use 'upper-right' instead of 'top-right' for window, page, or pane references to features or controls. Use 'top' and 'bottom' only as a general screen reference.", "location": {"path": "_dashboards/workspace/workspace-acl.md", "range": {"start": {"line": 185, "column": 38}}}, "severity": "WARNING"}
2. Click the selector which displays the current workspace privacy access level at the bottom of the panel.
3. Select the new access level from the dropdown list.
4. Select **Save** to apply the modifications.

0 comments on commit a244b07

Please sign in to comment.