diff --git a/packages/noco-docs/docs/020.getting-started/030.terminologies.md b/packages/noco-docs/docs/020.getting-started/030.terminologies.md index 5cfd28a391..2b4fee2692 100644 --- a/packages/noco-docs/docs/020.getting-started/030.terminologies.md +++ b/packages/noco-docs/docs/020.getting-started/030.terminologies.md @@ -22,11 +22,15 @@ Layout below shows broader components of NocoDB's UI. ## Terminologies -| Term | Description | -|-----:|:------------| -| | | -| | | -| | | -| | | -| | | -| | | \ No newline at end of file +| Term | Description | +|--------------------------:|:--------------------------------------------------------------------------------------------------------------| +| Workspace | Collection of one or more bases | +| Base | Collection of one or more tables, often related and linked to one another | +| Table | | +| Field | | +| Record | | +| View | | +| Workspace Collaborator | Workspace member with specific access permissions | +| Workspace Owner | Member who had created workspace. There can be only one owner for a workspace & ownership is non-transferable | +| Base Collaborator | Base member with specific access permissions | +| Base Owner | Member who had created base. There can be only one owner for a base & ownership is non-transferable | diff --git a/packages/noco-docs/docs/030.workspaces/010.workspace-overview.md b/packages/noco-docs/docs/030.workspaces/010.workspace-overview.md index 84e8ef6817..7df2fde6cb 100644 --- a/packages/noco-docs/docs/030.workspaces/010.workspace-overview.md +++ b/packages/noco-docs/docs/030.workspaces/010.workspace-overview.md @@ -12,12 +12,17 @@ Workspaces in NocoDB are collection of one or more bases. You can create multipl - A collaborator can be a member of multiple workspaces. - A collaborator can have different access permissions in different workspaces. -> Note: You can create only one workspace in the self-hosted plan (default). +:::info +You can create only one workspace in the self-hosted plan (default). +::: -Workspace menu is accessible from the left sidebar. +### Workspace context menu + +Workspace context menu is accessible from the left sidebar. ![image](/img/v2/workspace-menu.png) -It lists all the workspaces you have access to. You can switch between workspaces by clicking on the workspace name. +### List workspaces +Workspace context menu lists all the workspaces you have access to. You can switch between workspaces by clicking on the workspace name. ![image](/img/v2/workspace-list.png) \ No newline at end of file diff --git a/packages/noco-docs/docs/030.workspaces/020.create-workspace.md b/packages/noco-docs/docs/030.workspaces/020.create-workspace.md index 483844a829..fad54e27aa 100644 --- a/packages/noco-docs/docs/030.workspaces/020.create-workspace.md +++ b/packages/noco-docs/docs/030.workspaces/020.create-workspace.md @@ -2,4 +2,33 @@ title: 'Create workspace' --- import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; \ No newline at end of file +import TabItem from '@theme/TabItem'; + + +In NocoDB, bases are organized within workspaces. To build database schema or to work with tables, fields and data in a base, your initial step involves either creating a new workspace or receiving an invitation to join an existing one, typically extended by a workspace owner. + +In the following section, we will guide you through the process of creating your NocoDB workspaces. + +## Create a workspace + +1. Click on the **Workspace name** on the top of left sidebar to open **Workspace context menu**. +2. Select **Create workspace** button on the Workspace context menu. +3. Enter the **Workspace name** and click on the **Create Workspace** button + +![image](/img/v2/create-workspace-1.png) + + +![image](/img/v2/create-workspace-2.png) + + +Upon the creation of a new workspace, you are automatically designated as the workspace owner. Once your workspace is established, you have the authority to create bases and tables into it, as well as extend invitations to collaborators for participation. + +- There is no limit to the number of collaborators you can invite to your workspace. +- There is also no limit to the number of bases you can create within a workspace. +- There can be only one workspace owner (non-transferable). +- Only workspace owner has the authority to delete a workspace. + +:::info +- You can create only one workspace in the self-hosted plan (default). +- On signup, a default workspace is created for you. You can rename it or create a new one. +::: \ No newline at end of file diff --git a/packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md b/packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md index 27ed750854..fc22d8396f 100644 --- a/packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md +++ b/packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md @@ -2,4 +2,26 @@ title: 'Workspace collaboration' --- import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; \ No newline at end of file +import TabItem from '@theme/TabItem'; + +Next logical step after creating a workspace is to invite collaborators to it. In this section, we will guide you through the process of inviting collaborators to your workspace. + +## Invite collaborators +1. Click on `Team & Settings` on the left sidebar to open Workspace configuration page. +2. Click on `Collaborators` tab. +3. Fill in the email address of the collaborator you want to invite. +4. Select the access permission for the collaborator from the dropdown menu. +5. Click on `Add User(s)` button. + +![image](/img/v2/workspace-collaboration.png) + +### List of collaborators +List of the users who have access to the workspace is displayed on the same page. Refer **<1>** below. + +### Update collaborator access permission +You can change the access permission of the collaborator by clicking on the access drop down menu and selecting new role option as desired. Refer **<2>** below. + +### Remove collaborator +You can also remove collaborators from the workspace by clicking on the vertical ellipses `⋮` to open the context menu and selecting `Remove User` option. Refer **<3>** below. + +![image](/img/v2/workspace-collaboration-actions.png) \ No newline at end of file diff --git a/packages/noco-docs/docs/030.workspaces/040.delete-workspace.md b/packages/noco-docs/docs/030.workspaces/040.delete-workspace.md index 60c50ac867..a7cc29b1c0 100644 --- a/packages/noco-docs/docs/030.workspaces/040.delete-workspace.md +++ b/packages/noco-docs/docs/030.workspaces/040.delete-workspace.md @@ -2,4 +2,26 @@ title: 'Delete workspace' --- import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; \ No newline at end of file +import TabItem from '@theme/TabItem'; + +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. + +:::danger +**This action cannot be undone.** +::: + +:::info +Only **workspace owner** can delete a workspace. +::: + +To delete a workspace: + +1. Click on `Team & Settings` on the left sidebar to open Workspace configuration page. +2. Click on `Settings` tab. +3. Click on `Delete Workspace` button. +4. Key in the workspace name to confirm the deletion. +5. Click on `Delete Workspace` button on the confirmation dialog box. + +![image](/img/v2/workspace-delete.png) + +![image](/img/v2/workspace-delete-confirmation.png) diff --git a/packages/noco-docs/docs/030.workspaces/050.actions-on-workspace.md b/packages/noco-docs/docs/030.workspaces/050.actions-on-workspace.md index 482e063c1f..95a5c9c48c 100644 --- a/packages/noco-docs/docs/030.workspaces/050.actions-on-workspace.md +++ b/packages/noco-docs/docs/030.workspaces/050.actions-on-workspace.md @@ -2,4 +2,14 @@ title: 'Actions on workspace' --- import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; \ No newline at end of file +import TabItem from '@theme/TabItem'; + +## Rename workspace + +To change workspace name: +1. Click on `Team & Settings` on the left sidebar to open Workspace configuration page. +2. Click on `Settings` tab. +3. Feed in the new workspace name in the `Workspace Name` field. +4. Click on `Rename Workspace` button. + +![image](/img/v2/workspace-rename.png) diff --git a/packages/noco-docs/docs/040.bases/010.base-overview.md b/packages/noco-docs/docs/040.bases/010.base-overview.md index 2883b92ac0..91944429c4 100644 --- a/packages/noco-docs/docs/040.bases/010.base-overview.md +++ b/packages/noco-docs/docs/040.bases/010.base-overview.md @@ -2,4 +2,28 @@ title: 'Base overview' --- import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; \ No newline at end of file +import TabItem from '@theme/TabItem'; + +Bases are the core building blocks of NocoDB. A base is a collection of tables, views, forms, reports, dashboards, and automations. You can create multiple bases to organize your data and collaborators. Some of the key points to note about bases are: +- A base can be a part of only one workspace & cannot be moved between workspaces. +- Creator of a base is the `base owner`. There can be only one `base owner` (non-transferable). +- Only base owner has the authority to delete a base. +- Each base has its own set of collaborators and access permissions. +- Collaborator permissions at base level carry higher precedence than workspace level permissions. +- There is no limit to the number of collaborators you can invite to your base. +- There is no limit to the number of tables you can create within a base. + +## Base Dashboard + +Base dashboard is the landing page for a base. It provides a quick overview of the base. It also provides quick access to base settings & collaborations. Click on the base name in the left sidebar **<1>** to open the base dashboard **<2>**. + +![image](/img/v2/base-dashboard.png) + +Base dashboard has the following sections: +### Table List +List of tables in the base. Click on the table name to open the table. A base can consist of tables residing in external data sources as well. They are highlighted accordingly in the table list. +### Base Collaborators +List of collaborators in the base along with their current permission levels. Workspace collaborators inherit their access permissions to the base. Base owner can modify the permissions of collaborators at base level (either bump up or bump down). Additional details will be dealt with in section [Base Collaborations](/docs/040.bases/075.base-collaboration.md). +### Data Sources +NocoDB allows you to connect to external data sources & work with them as if they are native tables. List of connected data sources are listed here. Additional details will be dealt with in section [Data Sources](/docs/050.data-sources/010.data-sources-overview.md). + diff --git a/packages/noco-docs/docs/040.bases/020.create-base.md b/packages/noco-docs/docs/040.bases/020.create-base.md index 6aa2483c29..ba4720cf8c 100644 --- a/packages/noco-docs/docs/040.bases/020.create-base.md +++ b/packages/noco-docs/docs/040.bases/020.create-base.md @@ -2,4 +2,6 @@ title: 'Create base' --- import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; \ No newline at end of file +import TabItem from '@theme/TabItem'; + +## Create base from scratch diff --git a/packages/noco-docs/docs/040.bases/075.base-collaboration.md b/packages/noco-docs/docs/040.bases/075.base-collaboration.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/noco-docs/static/img/v2/base-dashboard.png b/packages/noco-docs/static/img/v2/base-dashboard.png new file mode 100644 index 0000000000..4fd72b560b Binary files /dev/null and b/packages/noco-docs/static/img/v2/base-dashboard.png differ diff --git a/packages/noco-docs/static/img/v2/create-workspace-1.png b/packages/noco-docs/static/img/v2/create-workspace-1.png new file mode 100644 index 0000000000..501fe4882f Binary files /dev/null and b/packages/noco-docs/static/img/v2/create-workspace-1.png differ diff --git a/packages/noco-docs/static/img/v2/create-workspace-2.png b/packages/noco-docs/static/img/v2/create-workspace-2.png new file mode 100644 index 0000000000..88aa47babf Binary files /dev/null and b/packages/noco-docs/static/img/v2/create-workspace-2.png differ diff --git a/packages/noco-docs/static/img/v2/workspace-collaboration-actions.png b/packages/noco-docs/static/img/v2/workspace-collaboration-actions.png new file mode 100644 index 0000000000..ac30dd7471 Binary files /dev/null and b/packages/noco-docs/static/img/v2/workspace-collaboration-actions.png differ diff --git a/packages/noco-docs/static/img/v2/workspace-collaboration.png b/packages/noco-docs/static/img/v2/workspace-collaboration.png new file mode 100644 index 0000000000..0699f4f367 Binary files /dev/null and b/packages/noco-docs/static/img/v2/workspace-collaboration.png differ diff --git a/packages/noco-docs/static/img/v2/workspace-delete-confirmation.png b/packages/noco-docs/static/img/v2/workspace-delete-confirmation.png new file mode 100644 index 0000000000..974aee66ef Binary files /dev/null and b/packages/noco-docs/static/img/v2/workspace-delete-confirmation.png differ diff --git a/packages/noco-docs/static/img/v2/workspace-delete.png b/packages/noco-docs/static/img/v2/workspace-delete.png new file mode 100644 index 0000000000..d9bc22e003 Binary files /dev/null and b/packages/noco-docs/static/img/v2/workspace-delete.png differ diff --git a/packages/noco-docs/static/img/v2/workspace-rename.png b/packages/noco-docs/static/img/v2/workspace-rename.png new file mode 100644 index 0000000000..57752ef0b0 Binary files /dev/null and b/packages/noco-docs/static/img/v2/workspace-rename.png differ