Browse Source

docs: collaboration

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
pull/6467/head
Raju Udava 1 year ago
parent
commit
0bd4cd6968
  1. 19
      packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md
  2. 2
      packages/noco-docs/docs/040.bases/050.base-collaboration.md
  3. 4
      packages/noco-docs/docs/040.bases/060.share-base.md
  4. 61
      packages/noco-docs/docs/090.roles-and-permissions/010.overview.md
  5. 25
      packages/noco-docs/docs/100.collaboration/010.overview.md
  6. 40
      packages/noco-docs/docs/100.collaboration/010.workspace-collaboration.md
  7. 28
      packages/noco-docs/docs/100.collaboration/020.base-collaboration.md
  8. 88
      packages/noco-docs/docs/100.collaboration/030.share-base.md
  9. 57
      packages/noco-docs/docs/100.collaboration/040.share-view.md

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

@ -44,22 +44,3 @@ To remove a member from the workspace, take the following steps:
- [Create workspace](/workspaces/create-workspace)
- [Rename workspace](/workspaces/actions-on-workspace#rename-workspace)
- [Delete workspace](/workspaces/actions-on-workspace#delete-workspace)
[//]: # (## List workspace members)
[//]: # (List of the users who have access to the workspace is displayed on the same page. )
[//]: # (![image]&#40;/img/v2/workspace/list-users.png&#41;)
[//]: # ()
[//]: # (## Update workspace member role)
[//]: # (You can change the access permission of the member by clicking on the access drop down menu and selecting new role option as desired. )
[//]: # (![image]&#40;/img/v2/workspace/change-role.png&#41;)
[//]: # ()
[//]: # (### Remove workspace member)
[//]: # (You can also remove members from the workspace by clicking on the vertical ellipses `⋮` to open the context menu and selecting `Remove User` option. )

2
packages/noco-docs/docs/040.bases/050.base-collaboration.md

@ -5,7 +5,7 @@ tags: ['bases', 'base collaboration']
keywords: ['NocoDB base', 'base collaboration', 'base context menu', 'base owner', 'base collaboration', 'base actions', 'base settings', 'base administration', 'base organization']
---
A member added to a workspace will carry his assigned role specific permissions to all the base with in workspace. To override member permissions to your base, please follow the clear steps outlined below:
A member added to a workspace will carry his assigned role specific permissions to all the base with in workspace. To override member permissions to your base, please follow steps outlined below:
1. Go to the left sidebar and select `Base name` to access the `Base Dashboard.`
2. Click on the `Members` tab.

4
packages/noco-docs/docs/040.bases/060.share-base.md

@ -14,10 +14,6 @@ To share a base, follow the steps below:
![Share base](/img/v2/base/shared-base-2.png)
![Share base](/img/v2/base/shared-base-3.png)
[//]: # (![share button]&#40;https://github.com/nocodb/nocodb/assets/86527202/44d85978-ad27-40a6-9fd5-ea17a0bd3a79&#41;)
[//]: # (![Share base modal]&#40;https://github.com/nocodb/nocodb/assets/86527202/4fc4e98a-d180-476d-8b5a-6a5903f081fc&#41;)
[//]: # (![shared base enable access]&#40;https://github.com/nocodb/nocodb/assets/86527202/c5d18e7d-69cb-474c-94f2-d863d8cbc2b3&#41;)
## Modify Share base
Amending the `Share base` setting will render the previously generated `Share base` link invalid and generate a new link in its place.

61
packages/noco-docs/docs/090.roles-and-permissions/010.overview.md

@ -105,67 +105,6 @@ to override at base level.
| API Snippet | ✔ | ✔ | ✔ | ✔ | ✔ |
| API Token | ✔ | ✔ | ✔ | ✔ | ✔ |
## Related Links
---------------
# Backup
Upon extending an invitation to a user, the assigning of their role level is an initial step in the process,
but it's important to note that this role designation can be modified at a later time. Our role system operates
incrementally, meaning that higher-level roles inherently encompass all the privileges associated with lower-level roles.
This hierarchical approach not only provides flexibility in tailoring permissions but also fosters a transparent
and responsible organizational structure within the framework of workspace or base management.
## Roles
Roles serve as the defining factor for the privileges assigned to users within NocoDB.
These roles can be associated with a member at two distinct levels: the Workspace level and the Base level.
When a member is invited to a Workspace and granted a specific role, such as an "Editor," they will
inherently carry that privilege across all the Bases within that particular Workspace by default.
However, it's essential to note that project owners or creators maintain the authority to enforce
customized permission settings at the project level, allowing for the fine-tuning of access and control as needed
to align with specific project requirements. This dual-level role assignment system ensures a flexible and adaptable
approach to user permissions and access management within NocoDB.
### Owner
When a member initiates the creation of a new Workspace or Base within our system, they are automatically designated
as the Workspace or Base "Owner." This ownership role comes with certain exclusive privileges, including the
sole authority to delete the Workspace or Base. It is important to note that the "Owner" role's privileges
are non-transferable, ensuring the integrity of ownership and control within the system.
### Creator
The role of "Creator" within our system encompasses all the privileges associated with a Workspace or Base "Owner,"
except the ability to delete the workspace or base. In essence, a "Creator" possesses the full spectrum of
administrative rights and control over the workspace or base, except for the authority to initiate its deletion.
This distinction ensures that while "Creators" can oversee and manage various aspects of the workspace or base,
the critical decision to remove it remains exclusive to the designated "Owner." This arrangement allows for a balanced
and secure approach to workspace or base management.
### Editor
The role of an "Editor" comes with specific limitations and permissions. An "Editor"
does not have the capability to make alterations to the project schema, such as adding tables, views or columns.
However, they are empowered to create and edit records within the project. This role is designed to strike a balance
between data input and schema management, ensuring that while "Editors" can contribute and modify content,
the structural integrity of the project remains protected and controlled by higher-level roles.
### Commenter
The "Commenter" role is characterized by its distinct set of permissions. Specifically, a "Commenter" does not
possess the ability to add or edit records within the designated context. However, their role is centered on the
capability to provide comments on existing records. This role is purposefully designed to facilitate communication
and feedback while maintaining a clear distinction from roles responsible for record creation and modification.
### Viewer
The role of a "Viewer" is defined by a specific set of permissions. In this capacity, individuals with the "Viewer"
role are granted access solely for the purpose of viewing records and associated comments. This role is intentionally
limited to passive observation and does not include the ability to contribute or make changes, ensuring a secure
and controlled environment for those who require access solely for informational purposes.
### No Access
The "No Access" role is a distinctive designation within NocoDB, and it is exclusively applied at the base level.
This role serves the specific purpose of revoking project access for the designated user at that particular base.
By assigning the "No Access" role, access to the associated project is effectively denied, providing a clear and effective
means of controlling user permissions and project participation. This role plays a crucial role in ensuring
security and access management within the system.

25
packages/noco-docs/docs/100.collaboration/010.overview.md

@ -1,5 +1,8 @@
---
title: 'Collaboration overview'
description: 'This article explains various collaboration features that NocoDB offers.'
tags: ['collaboration', 'workspace collaboration', 'base collaboration', 'share base', 'share view']
keywords: ['Collaboration overview', 'Workspace collaboration', 'Base collaboration', 'Share base', 'Share view', 'Team collaboration', 'Workspace management', 'Workspace settings', 'Workspace administration', 'Member invitation', 'User access', 'Member management', 'Workspace teamwork', 'Workspace organization']
---
@ -7,21 +10,7 @@ At NocoDB, our passion lies in promoting teamwork, and it's a significant factor
In this segment, we'll discuss various collaboration features that NocoDB offers.
# Workspace collaboration
## Inviting members to your workspace
## Managing member roles
## Removing members from your workspace
# Base collaboration
## Inviting members to your base
## Managing member roles
## Removing members from your base
## Share base
[Workspace collaboration](workspace-collaboration)
[Base collaboration](base-collaboration)
[Share base](share-base)
[Share view](share-view)

40
packages/noco-docs/docs/100.collaboration/010.workspace-collaboration.md

@ -0,0 +1,40 @@
---
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.'
tags: ['workspaces', 'collaboration', 'roles', 'invite']
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']
---
:::note
A comprehensive guide regarding roles and permissions can be accessed [here](/roles-and-permissions/overview).
:::
## Invite members
1. Navigate to the Workspace configuration page by selecting `Team & Settings` in the left sidebar.
2. Access the `Members` tab.
3. Input the email address of the intended member for the invitation.
4. Click on `Role` dropdown menu
5. Choose the appropriate access permission for the member from the dropdown menu.
6. Conclude the process by selecting the `Add Member(s)` button.
![image](/img/v2/workspace/workspace-collaboration.png)
:::info
You have the capability to invite multiple members simultaneously by entering their email addresses, separated by commas.
:::
## Displaying Workspace Members
The `Members` tab displays a list of users who have been granted access to the workspace.
![image](/img/v2/workspace/list-users.png)
## Modifying Workspace Member Roles
You can modify the access permissions of members by following these steps:
1. Access the dropdown menu.
2. Select the desired new role option.
![image](/img/v2/workspace/change-role.png)
## Removing Workspace Members
To remove a member from the workspace, take the following steps:
1. Click on the vertical ellipses `⋮` to open the context menu.
2. Select the `Remove User` option.
![image](/img/v2/workspace/remove-user.png)

28
packages/noco-docs/docs/100.collaboration/020.base-collaboration.md

@ -0,0 +1,28 @@
---
title: 'Base Collaboration'
description: 'Invite team members to work on a base'
tags: ['bases', 'base collaboration']
keywords: ['NocoDB base', 'base collaboration', 'base context menu', 'base owner', 'base collaboration', 'base actions', 'base settings', 'base administration', 'base organization']
---
## Inviting members to your base
A member added to a workspace will carry his assigned role specific permissions to all the base with in workspace. To override member permissions to your base, follow steps outlined below:
1. Go to the left sidebar and select `Base name` to access the `Base Dashboard.`
2. Click on the `Members` tab.
3. Use the dropdown menu to specify the access permissions for the member you wish to collaborate.
4. Finalize the process by assigning the desired role to the user.
![image](/img/v2/base/base-collaboration.png)
More details about roles & permissions can be found [here](/roles-and-permissions/overview).
## Removing members from your base
1. Go to the left sidebar and select `Base name` to access the `Base Dashboard.`
2. Click on the `Members` tab.
3. Use the dropdown menu to specify the access permissions for the member you wish to collaborate.
4. Assign the `No Access` role to the user.
![image](/img/v2/base/base-collaboration.png)

88
packages/noco-docs/docs/100.collaboration/030.share-base.md

@ -0,0 +1,88 @@
---
title: "Share Base"
description: "Procedures to share a base & generating embedded iframe"
tags: ["bases", "share base"]
keywords: ["NocoDB base", "share base", "base collaboration", "base actions", "base settings"]
---
To share a base, follow the steps below:
1. Navigate to the top right corner of the top navigation bar and click on the `Share` button.
2. In the `Shared base` section, toggle the switch to `Enable public access` in order to activate the shared base feature.
3. The generated link for the shared base will be displayed above and can be utilized to share this project with others. To copy the URL, simply click on the `Copy Link` option.
![Share base](/img/v2/base/shared-base-1.png)
![Share base](/img/v2/base/shared-base-2.png)
![Share base](/img/v2/base/shared-base-3.png)
## Modify Share base
Amending the `Share base` setting will render the previously generated `Share base` link invalid and generate a new link in its place.
Here are the steps to modify it:
1. Click on the `Share` button located in the top right corner of the toolbar.
2. Toggle the option labeled `Enable public access` to deactivate the base share.
3. Toggle the same option, `Enable public access,` to reactivate the base share, subsequently generating a new link.
## Disable Share base
Disabling `Share base` will render the previously generated `Share base` link invalid
Here are the steps to disable it:
1. Click on the 'Share' button located in the top right corner of the toolbar.
2. Toggle the option labeled `Enable public access` to deactivate the base share.
![Share base](/img/v2/base/shared-base-disable.png)
## Share base Access Permissions
The "Shared base" can be configured in two modes:
1. **Viewer** - Users with the provided link will have **read-only** access to the base data.
2. **Editor** - Users with the provided link will have **read and write** access to the base data.
Toggle `Enable Editor Access` button to configure permissions as desired
![Share base](/img/v2/base/shared-base-editor.png)
## Embeddable Frame
The NocoDB interface can be seamlessly integrated into existing applications through the utilization of the [HTML IFRAME](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) attribute. This feature empowers users to embed the NocoDB interface into their applications, allowing for a unified user experience. To generate the embeddable HTML code, follow these steps:
**To Generate Embeddable HTML Code:**
1. Click the `Share` button located in the top right corner of the toolbar.
2. Within the `Shared base link` tab, select the button to copy the `Embeddable HTML code` to your clipboard.
![Share base](/img/v2/base/shared-base-iframe.png)
Example:
```html
<iframe
class="nc-embed"
src="https://nocodb-nocodb-rsyir.ondigitalocean.app/dashboard/#/nc/base/e3bba9df-4fc1-4d11-b7ce-41c4a3ad6810?embed"
frameBorder="0"
width="100%"
height="700"
style="background: transparent; border: 1px solid #ddd"
>
</iframe>
```
### Embed into application's HTML Body
Sample code with embedded iframe generated above
```html
<!DOCTYPE html>
<html>
<body>
<iframe
class="nc-embed"
src="http://localhost:3000/#/nc/base/7d4b551c-b5e0-41c9-a87b-f3984c21d2c7?embed"
frameBorder="0"
width="100%"
height="700"
style="background: transparent; "
></iframe>
</body>
</html>
```

57
packages/noco-docs/docs/100.collaboration/040.share-view.md

@ -0,0 +1,57 @@
---
title: "Share View"
description: "Procedures to share a view"
tags: ["views", "share view", "share"]
keywords: ["NocoDB view", "share view", "share", "share view with password protection", "share view with download options"]
---
## Generate Share View
1. Click `Share` button on the top right of the toolbar
![share button](/img/v2/views/share-button.png)
2. Toggle `Enable public viewing` to create shared view link
![shared view](/img/v2/views/share-view-1.png)
3. Click `Copy` button to copy the link to clipboard
![copy link](/img/v2/views/share-view-copy-link.png)
### Share view options
#### Password protection
You can enable `Restrict access with a password` if you want a password-protected view
![password protection](/img/v2/views/share-view-password.png)
#### Download options
You can toggle `Allow Download` button to enable or disable download CSV/XLSX options in the shared view link
![download options](/img/v2/views/share-view-download.png)
### Share Form View Options
Form view has additional customizations for shared view. You can enable/disable the following options for shared form view:
1. `Survey mode`: This option when enabled, will display the form in survey mode.
2. `RTL Orientation`: This option when enabled, will display the form in RTL orientation.
3. `Themes`: You can select a theme for the form from the dropdown.
![form view options](/img/v2/views/form-specific-configurations.png)
## Access Share View
To access the shared view, please follow the steps below:
Click on the `Shared View URL`. If the URL is password-protected, you will be prompted to enter the password to unlock it. Please input the required password to proceed.
![image](https://user-images.githubusercontent.com/35857179/194690379-e3d89df6-d9c1-4d9d-9e8c-7e59c3978d31.png)
Once the password is successfully entered and authenticated, you will gain access to the shared view.
In the event that the URL is not password-protected, you will be directed to the shared view directly, without the need for a password.
![image](https://user-images.githubusercontent.com/35857179/194690389-5b78e236-aacc-49c2-898e-110f95edd1e5.png)
Users with the shared view link can only view the data and cannot make any changes to the view or its content. Records and fields in the shared view will be updated in real-time as changes are made to the original view. Users accessing shared view can apply filters and sort records as per their requirements.
:::info
Note that, filters & sorts applied to shared view will not be persisted. These filters & sorts will be reset when the shared view is accessed again.
:::
Loading…
Cancel
Save