Browse Source

docs: workspace refactor

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
pull/6467/head
Raju Udava 1 year ago
parent
commit
df24963d71
  1. 3
      packages/noco-docs/docs/030.workspaces/010.workspace-overview.md
  2. 11
      packages/noco-docs/docs/030.workspaces/020.create-workspace.md
  3. 40
      packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md
  4. 8
      packages/noco-docs/docs/030.workspaces/040.actions-on-workspace.md
  5. 15
      packages/noco-docs/docs/120.collaboration/010.workspace-collaboration.md
  6. BIN
      packages/noco-docs/static/img/v2/workspace/change-role.png
  7. BIN
      packages/noco-docs/static/img/v2/workspace/create-workspace-1.png
  8. BIN
      packages/noco-docs/static/img/v2/workspace/create-workspace-2.png
  9. BIN
      packages/noco-docs/static/img/v2/workspace/delete-workspace-confirmation.png
  10. BIN
      packages/noco-docs/static/img/v2/workspace/delete-workspace.png
  11. BIN
      packages/noco-docs/static/img/v2/workspace/list-users.png
  12. BIN
      packages/noco-docs/static/img/v2/workspace/remove-user.png
  13. BIN
      packages/noco-docs/static/img/v2/workspace/rename-workspace.png
  14. BIN
      packages/noco-docs/static/img/v2/workspace/workspace-collaboration.png
  15. BIN
      packages/noco-docs/static/img/v2/workspace/workspace-context-menu.png
  16. BIN
      packages/noco-docs/static/img/v2/workspace/workspace-create-2.png
  17. BIN
      packages/noco-docs/static/img/v2/workspace/workspace-create.png
  18. BIN
      packages/noco-docs/static/img/v2/workspace/workspace-delete-confirmation.png
  19. BIN
      packages/noco-docs/static/img/v2/workspace/workspace-delete.png
  20. BIN
      packages/noco-docs/static/img/v2/workspace/workspace-members-list.png
  21. BIN
      packages/noco-docs/static/img/v2/workspace/workspace-members-remove.png
  22. BIN
      packages/noco-docs/static/img/v2/workspace/workspace-members-role-change.png
  23. BIN
      packages/noco-docs/static/img/v2/workspace/workspace-rename.png

3
packages/noco-docs/docs/030.workspaces/010.workspace-overview.md

@ -1,6 +1,7 @@
--- ---
title: 'Workspace overview' title: 'Workspace overview'
tags: [Workspace, List workspaces, Switch between workspaces] description: 'This article briefs the concept of workspaces in NocoDB.'
tags: ['Workspace', 'Overview']
--- ---
NocoDB workspaces are a crucial feature for organizing and managing your data effectively: NocoDB workspaces are a crucial feature for organizing and managing your data effectively:

11
packages/noco-docs/docs/030.workspaces/020.create-workspace.md

@ -1,7 +1,7 @@
--- ---
title: 'Create workspace' title: 'Create workspace'
description: 'How to create a workspace in NocoDB?' description: 'This article explains how to create a workspace'
tags: ['workspaces'] tags: ['Workspace', 'Create']
keywords: ['NocoDB workspace', 'create workspace', 'workspace context menu', 'workspace owner', 'workspace collaboration', 'workspace actions', 'default workspace'] keywords: ['NocoDB workspace', 'create workspace', 'workspace context menu', 'workspace owner', 'workspace collaboration', 'workspace actions', 'default workspace']
--- ---
@ -14,11 +14,12 @@ In the following section, lets look at the process of creating your NocoDB works
1. Navigate to the top-left corner of the sidebar and select the **Workspace name** to access the **Workspace context menu**. 1. Navigate to the top-left corner of the sidebar and select the **Workspace name** to access the **Workspace context menu**.
2. From the Workspace context menu, opt for the **Create workspace** button. 2. From the Workspace context menu, opt for the **Create workspace** button.
3. Provide a name for the workspace, then proceed by clicking the **Create Workspace** button. 3. Provide a name for the workspace
4. Proceed by clicking the **Create Workspace** button.
![image](/img/v2/workspace/create-workspace-1.png) ![image](/img/v2/workspace/workspace-create.png)
![image](/img/v2/workspace/create-workspace-2.png) ![image](/img/v2/workspace/workspace-create-2.png)
When you start a new workspace, you automatically become the owner. When you start a new workspace, you automatically become the owner.

40
packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md

@ -1,14 +1,14 @@
--- ---
title: 'Workspace collaboration' title: 'Workspace collaboration'
description: 'This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.' description: 'This article explains how to invite members to your workspace, change their roles and procedure to remove them from the workspace.'
tags: ['workspaces', 'collaboration', 'roles', 'invite'] tags: ['Workspace', 'Collaboration', 'Members', 'Invite', 'Roles', 'Permissions']
keywords: ['Workspace configuration', 'Invite members', 'Member roles', 'Access permissions', 'Displaying workspace members', 'Modifying member roles', 'Removing workspace members', 'Workspace collaboration', 'Team collaboration', 'Access control', 'Role-based permissions', 'Workspace management', 'User roles', 'Workspace settings', 'Workspace administration', 'Member invitation', 'User access', 'Member management', 'Workspace teamwork', 'Workspace organization'] keywords: ['Workspace configuration', 'Invite members', 'Member roles', 'Access permissions', 'Displaying workspace members', 'Modifying member roles', 'Removing workspace members', 'Workspace collaboration', 'Team collaboration', 'Access control', 'Role-based permissions', 'Workspace management', 'User roles', 'Workspace settings', 'Workspace administration', 'Member invitation', 'User access', 'Member management', 'Workspace teamwork', 'Workspace organization']
--- ---
Next logical step after creating a workspace is to invite members to it. In this section, we will guide you through the process of inviting members to your workspace. Next logical step after creating a workspace is to invite members to it. In this section, we will guide you through the process of inviting members to your workspace.
A comprehensive guide regarding roles and permissions can be accessed [here](/roles-and-permissions/overview). A comprehensive guide regarding roles and permissions can be accessed [here](/roles-and-permissions/overview).
## Invite members ## Invite members to Workspace
1. Navigate to the Workspace configuration page by selecting `Team & Settings` in the left sidebar. 1. Navigate to the Workspace configuration page by selecting `Team & Settings` in the left sidebar.
2. Access the `Members` tab. 2. Access the `Members` tab.
3. Input the email address of the intended member for the invitation. 3. Input the email address of the intended member for the invitation.
@ -18,26 +18,36 @@ A comprehensive guide regarding roles and permissions can be accessed [here](/ro
![image](/img/v2/workspace/workspace-collaboration.png) ![image](/img/v2/workspace/workspace-collaboration.png)
:::info :::tip
You have the capability to invite multiple members simultaneously by entering their email addresses, separated by commas. You can invite multiple members simultaneously by entering their email addresses, separated by commas.
::: :::
## Displaying Workspace Members ## List Workspace members
The `Members` tab displays a list of users who have been granted access to the workspace. The `Members` tab in `Team & Settings` displays a list of users who have been granted access to the workspace.
![image](/img/v2/workspace/list-users.png)
## Modifying Workspace Member Roles 1. Navigate to the Workspace configuration page by selecting `Team & Settings` in the left sidebar.
2. Access the `Members` tab.
![image](/img/v2/workspace/workspace-members-list.png)
## Modify Workspace Member Roles
You can modify the access permissions of members by following these steps: You can modify the access permissions of members by following these steps:
1. Access the dropdown menu. 1. Navigate to the Workspace configuration page by selecting `Team & Settings` in the left sidebar.
2. Select the desired new role option. 2. Access the `Members` tab.
![image](/img/v2/workspace/change-role.png) 3. Access the dropdown menu.
4. Select the desired new role option.
![image](/img/v2/workspace/workspace-members-role-change.png)
## Removing Workspace Members ## Remove Workspace Members
To remove a member from the workspace, take the following steps: To remove a member from the workspace, take the following steps:
1. Click on the vertical ellipses `⋮` to open the context menu. 1. Navigate to the Workspace configuration page by selecting `Team & Settings` in the left sidebar.
2. Select the `Remove User` option. 2. Access the `Members` tab.
![image](/img/v2/workspace/remove-user.png) 3. Click on the vertical ellipses `⋮` to open the context menu.
4. Select the `Remove User` option.
![image](/img/v2/workspace/workspace-members-remove.png)
## Related articles ## Related articles
- [Workspace overview](/workspaces/workspace-overview) - [Workspace overview](/workspaces/workspace-overview)

8
packages/noco-docs/docs/030.workspaces/040.actions-on-workspace.md

@ -1,7 +1,7 @@
--- ---
title: 'Actions on workspace' title: 'Actions on workspace'
description: 'This article explains how to rename or delete a workspace.' description: 'This article explains how to rename or delete a workspace.'
tags: ['workspaces', 'rename workspace', 'delete workspace'] tags: ['Workspace', 'Rename', 'Delete']
keywords: ['Workspace configuration', 'Rename workspace', 'Delete workspace', 'Workspace actions', 'Workspace management', 'Workspace administration', 'Workspace settings', 'Workspace organization'] keywords: ['Workspace configuration', 'Rename workspace', 'Delete workspace', 'Workspace actions', 'Workspace management', 'Workspace administration', 'Workspace settings', 'Workspace organization']
--- ---
@ -15,7 +15,7 @@ To update the workspace name:
3. Enter the new desired workspace name in the `Workspace Name` field. 3. Enter the new desired workspace name in the `Workspace Name` field.
4. Confirm the change by clicking on the `Rename Workspace` button. 4. Confirm the change by clicking on the `Rename Workspace` button.
![image](/img/v2/workspace/rename-workspace.png) ![image](/img/v2/workspace/workspace-rename.png)
## Delete workspace ## Delete workspace
If you determine that a workspace is no longer necessary, you have the option to permanently remove it from your settings. Deleting a workspace will delete all the bases and data associated with it. If you determine that a workspace is no longer necessary, you have the option to permanently remove it from your settings. Deleting a workspace will delete all the bases and data associated with it.
@ -36,8 +36,8 @@ To remove a workspace:
4. Provide the workspace name as confirmation for deletion. 4. Provide the workspace name as confirmation for deletion.
5. Confirm the action by clicking the `Delete Workspace` button in the confirmation dialog box. 5. Confirm the action by clicking the `Delete Workspace` button in the confirmation dialog box.
![image](/img/v2/workspace/delete-workspace.png) ![image](/img/v2/workspace/workspace-delete.png)
![image](/img/v2/workspace/delete-workspace-confirmation.png) ![image](/img/v2/workspace/workspace-delete-confirmation.png)
## Related articles ## Related articles
- [Workspace overview](/workspaces/workspace-overview) - [Workspace overview](/workspaces/workspace-overview)

15
packages/noco-docs/docs/120.collaboration/010.workspace-collaboration.md

@ -9,7 +9,7 @@ keywords: ['Workspace configuration', 'Invite members', 'Member roles', 'Access
A comprehensive guide regarding roles and permissions can be accessed [here](/roles-and-permissions/overview). A comprehensive guide regarding roles and permissions can be accessed [here](/roles-and-permissions/overview).
::: :::
## Invite members ## Invite members to Workspace
1. Navigate to the Workspace configuration page by selecting `Team & Settings` in the left sidebar. 1. Navigate to the Workspace configuration page by selecting `Team & Settings` in the left sidebar.
2. Access the `Members` tab. 2. Access the `Members` tab.
3. Input the email address of the intended member for the invitation. 3. Input the email address of the intended member for the invitation.
@ -23,18 +23,19 @@ A comprehensive guide regarding roles and permissions can be accessed [here](/ro
You have the capability to invite multiple members simultaneously by entering their email addresses, separated by commas. You have the capability to invite multiple members simultaneously by entering their email addresses, separated by commas.
::: :::
## Displaying Workspace Members
## List Workspace members
The `Members` tab displays a list of users who have been granted access to the workspace. The `Members` tab displays a list of users who have been granted access to the workspace.
![image](/img/v2/workspace/list-users.png) ![image](/img/v2/workspace/workspace-members-list.png)
## Modifying Workspace Member Roles ## Modify Workspace Member Roles
You can modify the access permissions of members by following these steps: You can modify the access permissions of members by following these steps:
1. Access the dropdown menu. 1. Access the dropdown menu.
2. Select the desired new role option. 2. Select the desired new role option.
![image](/img/v2/workspace/change-role.png) ![image](/img/v2/workspace/workspace-members-role-change.png)
## Removing Workspace Members ## Remove Workspace Members
To remove a member from the workspace, take the following steps: To remove a member from the workspace, take the following steps:
1. Click on the vertical ellipses `⋮` to open the context menu. 1. Click on the vertical ellipses `⋮` to open the context menu.
2. Select the `Remove User` option. 2. Select the `Remove User` option.
![image](/img/v2/workspace/remove-user.png) ![image](/img/v2/workspace/workspace-members-remove.png)

BIN
packages/noco-docs/static/img/v2/workspace/change-role.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 89 KiB

BIN
packages/noco-docs/static/img/v2/workspace/create-workspace-1.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 73 KiB

BIN
packages/noco-docs/static/img/v2/workspace/create-workspace-2.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 110 KiB

BIN
packages/noco-docs/static/img/v2/workspace/delete-workspace-confirmation.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

BIN
packages/noco-docs/static/img/v2/workspace/delete-workspace.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 98 KiB

BIN
packages/noco-docs/static/img/v2/workspace/list-users.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

BIN
packages/noco-docs/static/img/v2/workspace/remove-user.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

BIN
packages/noco-docs/static/img/v2/workspace/rename-workspace.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 106 KiB

BIN
packages/noco-docs/static/img/v2/workspace/workspace-collaboration.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 140 KiB

After

Width:  |  Height:  |  Size: 355 KiB

BIN
packages/noco-docs/static/img/v2/workspace/workspace-context-menu.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 153 KiB

BIN
packages/noco-docs/static/img/v2/workspace/workspace-create-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 214 KiB

BIN
packages/noco-docs/static/img/v2/workspace/workspace-create.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 154 KiB

BIN
packages/noco-docs/static/img/v2/workspace/workspace-delete-confirmation.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 270 KiB

BIN
packages/noco-docs/static/img/v2/workspace/workspace-delete.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 270 KiB

BIN
packages/noco-docs/static/img/v2/workspace/workspace-members-list.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 255 KiB

BIN
packages/noco-docs/static/img/v2/workspace/workspace-members-remove.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 263 KiB

BIN
packages/noco-docs/static/img/v2/workspace/workspace-members-role-change.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 301 KiB

BIN
packages/noco-docs/static/img/v2/workspace/workspace-rename.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 286 KiB

Loading…
Cancel
Save