Skip to content

Commit b86812f

Browse files
authored
Merge pull request #155 from nocodb/docs/0717-cleanup
Docs/0717 cleanup
2 parents 66a44e7 + b2e993f commit b86812f

File tree

8 files changed

+174
-209
lines changed

8 files changed

+174
-209
lines changed
Lines changed: 31 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Actions on base'
3-
description: 'Actions you can perform on a base in NocoDB: Rename, duplicate, delete, star a base.'
3+
description: "Understand the structure, actions, and developer tools available in a base."
44
tags: ['Bases', 'Rename', 'Duplicate', 'Delete', 'Relations', 'Swagger', 'REST APIs']
55
keywords: ['NocoDB base', 'base rename', 'base duplicate', 'base delete', 'base star', 'base context menu', 'base owner', 'base collaboration', 'base actions']
66
---
@@ -11,11 +11,10 @@ The base context menu offers a selection of swift actions that can be executed o
1111

1212

1313
## Rename base
14-
To modify the name of a base, you can easily do so by following these steps:
1514

16-
1. Initiate the base context menu by clicking on the ellipses `...` located next to the base name within the left sidebar.
17-
2. In the dropdown menu that appears, choose the `Rename` option.
18-
3. Input the new name for the base directly within the field provided and then press the `Enter` key to confirm and save the updated name.
15+
1. Open [Base context menu](#base-context-menu).
16+
2. From dropdown, select `Rename` option.
17+
3. Edit the name and press `Enter` to save.
1918

2019
![base context menu](/img/v2/base/base-context-menu.png)
2120

@@ -24,66 +23,59 @@ To modify the name of a base, you can easily do so by following these steps:
2423

2524
## Star base
2625
You can star a base by following simple steps below:
27-
1. Initiate the base context menu by clicking on the ellipses `...` located next to the base name within the left sidebar.
28-
2. In the dropdown menu that appears, choose the `Add to Starred` option.
29-
3. Subsequently, the designated base will be placed into the "Starred" section, conveniently positioned within the left sidebar.
26+
1. Open [Base context menu](#base-context-menu).
27+
2. From dropdown, select `Add to starred` option.
28+
29+
Subsequently, the base will be placed into the "Starred" section, conveniently positioned within the left sidebar.
3030

3131
![base context menu](/img/v2/base/base-context-menu.png)
3232

3333
![base starred](/img/v2/base/base-starred.png)
3434

35-
<Callout type="info">Starred base will appear in the `Starred` section on the left sidebar</Callout>
36-
3735
### Remove a base from starred list
38-
1. Initiate the base context menu by clicking on the ellipses `...` located next to the base name within the left sidebar.
39-
2. In the dropdown menu that appears, choose the `Remove from Starred` option.
40-
3. Subsequently, the designated base will be removed from the `Starred` section.
36+
You can star a base by following simple steps below:
37+
1. Open [Base context menu](#base-context-menu).
38+
2. From dropdown, select `Remove from starred` option.
4139

4240
![image](/img/v2/base/base-remove-from-starred.png)
4341

4442
## Duplicate base
4543

46-
To duplicate a base, you can follow these straightforward steps:
47-
1. Initiate the base context menu by clicking on the ellipses `...` located next to the base name within the left sidebar.
48-
2. In the dropdown menu that appears, choose the `Duplicate` option.
49-
3. Optionally, you can configure the duplication process with the following choices:
50-
- `Include records`: You have the flexibility to choose whether to duplicate the base with or without its data.
51-
- `Include comments`: You can decide whether to duplicate the base with or without its comments.
52-
4. Optionally, you can choose workspace to duplicate the base to from the dropdown menu. By default, the base will be duplicated to the same workspace as the original base. Note that, only workspaces that you have access to will be listed in the dropdown menu.
53-
5. Click the `Duplicate Base` button in the confirmation modal that pops up.
44+
1. Open [Base context menu](#base-context-menu).
45+
2. From dropdown, select `Duplicate base` option.
46+
3. Duplicate base optional configurations,
47+
- `Include records` - disable to duplicate the base schema only, without any data.
48+
- `Include comments` - disable to duplicate the base without any comments.
49+
- `Include scripts` - disable to duplicate the base without any scripts.
50+
4. You can select a workspace from the dropdown to duplicate the base into. By default, the base will be duplicated within its current workspace. Only workspaces where you have access will appear in the dropdown.
51+
5. Click the `Duplicate Base` button to proceed with the duplication.
5452

5553
A new base will be created, mirroring the original base's schema and data and/or comments based on the configurations specified in step 3.
5654

5755
![base context menu](/img/v2/base/base-context-menu.png)
5856

5957
![image](/img/v2/base/base-duplicate.png)
6058

61-
<Callout type="info">
62-
- A duplicate base will be generated within the same workspace as the original base.
63-
- The duplicated base will be suffixed with ` copy` in its name.
64-
- You will be designated as the `base owner` upon the duplication of the base.
65-
- Existing base members will not be transferred to the duplicated base.
66-
</Callout>
59+
<Callout type="info">You will be designated as the `base owner` upon the duplication of the base. Existing base members will not be transferred to the duplicated base.</Callout>
6760

6861
## Delete base
6962

7063
If you determine that a base is no longer necessary, you have the option to permanently remove it from your workspace. Deleting a base will delete all the tables and data associated with it.
7164

72-
<Callout type="info">**This action cannot be undone**</Callout>
73-
74-
<Callout type="info">Only **base owner** can delete a workspace</Callout>
65+
<Callout type="info">Only **base owner** can delete a workspace. **This action cannot be undone**</Callout>
7566

7667
To delete a base:
7768

78-
1. Initiate the base context menu by clicking on the ellipses `...` located next to the base name within the left sidebar.
79-
2. In the dropdown menu that appears, choose the `Delete` option.
69+
1. Open [Base context menu](#base-context-menu).
70+
2. From dropdown, select `Delete base` option.
8071
3. Select `Delete base` button on the confirmation dialog box.
8172

8273
![base context menu](/img/v2/base/base-context-menu.png)
8374

8475
![base delete](/img/v2/base/base-delete.png)
8576

8677
## Developer features
78+
8779
### Base settings
8880
Some general configurations are available for you to modify within the base settings.
8981
1. **Show M2M tables**: Toggle this option to display/hide M2M tables within the left sidebar. Many-to-many relation is supported via a junction table & is hidden by default.
@@ -92,39 +84,29 @@ Some general configurations are available for you to modify within the base sett
9284

9385
To configure base settings, you can follow these steps:
9486

95-
1. Initiate the base context menu by clicking on the ellipses `...` located next to the base name within the left sidebar.
96-
2. In the dropdown menu that appears, choose the `Settings` option.
87+
1. Open [Base context menu](#base-context-menu).
88+
2. From dropdown, select `Settings` option.
9789

9890
![base context menu](/img/v2/base/base-context-menu.png)
9991

10092
![base settings](/img/v2/base/base-settings.png)
10193

10294
### REST APIs
10395
NocoDB provides a Swagger UI for each base. To access the Swagger UI, follow these steps:
104-
1. Initiate the base context menu by clicking on the ellipses `...` located next to the base name within the left sidebar.
105-
2. In the dropdown menu that appears, choose the `REST APIs` option.
96+
1. Open [Base context menu](#base-context-menu).
97+
2. From dropdown, select `REST APIs` option.
10698

10799
![base context menu](/img/v2/base/base-context-menu.png)
108100

109101
![swagger](/img/v2/base/base-swagger.png)
110102

111103
### Relations
112104
NocoDB provides a visual representation of the relations between tables within a base. To access the relations diagram, follow these steps:
113-
1. Initiate the base context menu by clicking on the ellipses `...` located next to the base name within the left sidebar.
114-
2. In the dropdown menu that appears, choose the `Relations` option.
105+
1. Open [Base context menu](#base-context-menu).
106+
2. From dropdown, select `Relations` option.
115107

116108
![base context menu](/img/v2/base/base-context-menu.png)
117109

118110
![base relations](/img/v2/base/base-relations.png)
119111

120-
121-
## Related articles
122-
- [Base overview](/docs/product-docs/bases)
123-
- [Create an empty base](/docs/product-docs/bases/create-base)
124-
- [Import base from Airtable](/docs/product-docs/bases/import-base-from-airtable)
125-
- [Invite team members to work on a base](/docs/product-docs/bases/base-collaboration)
126-
- [Share base publicly](/docs/product-docs/bases/share-base)
127-
- [Rename base](/docs/product-docs/bases/actions-on-base#rename-base)
128-
- [Duplicate base](/docs/product-docs/bases/actions-on-base#duplicate-base)
129-
- [Bookmark base](/docs/product-docs/bases/actions-on-base#star-base)
130-
- [Delete base](/docs/product-docs/bases/actions-on-base#delete-base)
112+
---

content/docs/bases/base-collaboration.mdx

Lines changed: 30 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,38 +5,44 @@ tags: ['Bases', 'Collaboration', 'Members', 'Invite', 'Roles', 'Permissions']
55
keywords: ['NocoDB base', 'base collaboration']
66
---
77

8-
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:
8+
In NocoDB, a member added to a workspace inherits their role-based permissions across all bases within that workspace. If you need to override a member’s permissions for a specific base, follow the steps below:
99

10-
1. Go to the left sidebar and select `Base name` to access the `Base Dashboard.`
11-
2. Click on the `Members` tab.
12-
3. Use the dropdown menu to specify the access permissions for the member you wish to collaborate.
13-
4. Finalize the process by assigning the desired role to the user.
10+
11+
## Update members role in your base
12+
13+
1. Access `Base Dashboard` from the left sidebar
14+
2. Navigate to the `Members` tab.
15+
3. Locate the user whose access you want to change.
16+
4. Use the dropdown to assign a new role specific to this base.
1417

1518
![image](/img/v2/base/base-collaboration.png)
1619

1720

18-
<Callout type="info">
19-
- Any existing user can invite members to the base, but they can only assign a role to new members that is at most equal to their own role.
20-
- Only the base owner / creator can change the role of a base member.
21-
</Callout>
21+
<Callout type="info"> Any existing user can invite members to the base, but they can only assign roles that are equal to or lower than their own role. Only the base owner / creator can change the role of a base member.</Callout>
2222

2323
More details about roles & permissions can be found [here](/docs/product-docs/roles-and-permissions).
2424

25-
## Removing members from your base
26-
1. Go to the left sidebar and select `Base name` to access the `Base Dashboard.`
27-
2. Click on the `Members` tab.
28-
3. Use the dropdown menu to specify the access permissions for the member you wish to collaborate.
29-
4. Assign the `No Access` role to the user.
25+
## Remove members from your base
26+
1. Access `Base Dashboard` from the left sidebar
27+
2. Navigate to the `Members` tab.
28+
3. Locate the user to remove.
29+
4. Set their role to No Access using the dropdown.
3030

3131
![image](/img/v2/base/base-collaboration.png)
3232

33-
## Related articles
34-
- [Base overview](/docs/product-docs/bases)
35-
- [Create an empty base](/docs/product-docs/bases/create-base)
36-
- [Import base from Airtable](/docs/product-docs/bases/import-base-from-airtable)
37-
- [Invite team members to work on a base](/docs/product-docs/bases/base-collaboration)
38-
- [Share base publicly](/docs/product-docs/bases/share-base)
39-
- [Rename base](/docs/product-docs/bases/actions-on-base#rename-base)
40-
- [Duplicate base](/docs/product-docs/bases/actions-on-base#duplicate-base)
41-
- [Bookmark base](/docs/product-docs/bases/actions-on-base#star-base)
42-
- [Delete base](/docs/product-docs/bases/actions-on-base#delete-base)
33+
<Callout type="info">Removing a member from a base does not delete their account. They can still access other bases in the workspace, unless removed from the workspace entirely.</Callout>
34+
35+
## Direct base invite
36+
37+
In addition to inviting workspace members to a base, you can invite users directly to a specific base (with restricted workspace access). This is useful when you want to grant someone access to only a single base without exposing the rest of the workspace.
38+
39+
When a user is invited directly to a base:
40+
41+
* They are automatically added to the parent workspace with the **No Access** role.
42+
* Their access is restricted exclusively to the base they were invited into.
43+
* They will not be able to view or access any other bases, tables, or data within the same workspace.
44+
* Their name will still appear in the workspace’s member list, but their visibility and access will be limited.
45+
46+
This approach is ideal for sharing specific projects with external collaborators, clients, or temporary contributors without compromising workspace-level visibility.
47+
48+
---

content/docs/bases/create-base.mdx

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,14 @@ To initiate the creation of a new database from the ground up, follow these step
2222

2323
<Callout type="info">When you create a base, you become its owner. Only base owners can delete a base, and multiple bases can be created within a single workspace</Callout>
2424

25-
On the successful creation of a base, you will be directed to the Base Dashboard, which serves as the primary landing page for the base. This central hub provides users with swift access to essential features such as base settings and collaboration tools. To access the Base Dashboard, simply click on the base name located in the left sidebar.
25+
On the successful creation of a base, you will be directed to the Base Dashboard, which serves as the primary landing page for the base.
2626

2727
Find more details on adding tables to a base in the [Tables](/docs/product-docs/tables/create-table) section.
2828

29-
## Related articles
30-
- [Base overview](/docs/product-docs/bases)
31-
- [Import base from Airtable](/docs/product-docs/bases/import-base-from-airtable)
32-
- [Invite team members to work on a base](/docs/product-docs/bases/base-collaboration)
33-
- [Share base publicly](/docs/product-docs/bases/share-base)
34-
- [Rename base](/docs/product-docs/bases/actions-on-base#rename-base)
35-
- [Duplicate base](/docs/product-docs/bases/actions-on-base#duplicate-base)
36-
- [Bookmark base](/docs/product-docs/bases/actions-on-base#star-base)
37-
- [Delete base](/docs/product-docs/bases/actions-on-base#delete-base)
29+
## Create base using AI
30+
31+
<Callout type="info">This feature is available only on NocoDB Cloud. It is not supported in self-hosted or on-premise deployments.</Callout>
32+
33+
[Noco AI](/docs/product-docs/noco-ai) lets you instantly generate a complete base — including tables, views, fields, and relationships — just by describing your needs in natural language. Refer details [here](/docs/product-docs/noco-ai/create-base) for more details on how to use this feature.
34+
35+
---

content/docs/bases/import-base-from-airtable.mdx

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,17 @@
11
---
22
title: 'Import Airtable to NocoDB'
3-
description: 'A complete import of your Airtable to any MySQL or Postgres databases within minutes'
3+
description: 'A complete import of your Airtable base to NocoDB within minutes'
44
tags: ['Bases', 'Import']
55
keywords: ['NocoDB', 'Airtable', 'Import Airtable', 'Airtable to NocoDB', 'Airtable to MySQL', 'Airtable to Postgres']
66
---
77

8-
NocoDB offers a streamlined process for seamlessly transferring your Airtable database to various database management systems, including MySQL, Postgres and SQLite, in just a matter of minutes. This feature is particularly useful for users who wish to migrate their Airtable database to a more robust and scalable database management system.
9-
108
<Callout type="info">Import from Airtable is in beta version. See [Importing Airtable To NocoDB](https://github.com/nocodb/nocodb/discussions/2122) for the migration notes</Callout>
119

10+
<Callout type="info">To proceed, you must have valid Airtable Credentials. Ensure you have access to [Personal Access Token](#create-personal-access-token) and [Shared Base ID / URL](#retrieve-share-base-id--url)</Callout>
1211

13-
<Callout type="info">
14-
To proceed, you must have valid Airtable Credentials. Ensure you have access to the following information from your Airtable account:
15-
- [Personal Access Token](#create-personal-access-token)
16-
- [Shared Base ID / URL](#retrieve-share-base-id--url)
17-
</Callout>
12+
## Access import modal
1813

19-
Open the `Import from Airtable` modal to begin the import process
14+
Open the **Import from Airtable** modal to begin the import process
2015
1. Hover over the base name in the left sidebar, click on the `...` icon to open base context menu
2116
2. Select `Import Data` from the base context menu
2217
3. Select `Airtable`
@@ -27,12 +22,13 @@ Alternatively, you can also access this modal from the `Base dashboard`
2722
1. Go to your Base dashboard, click on `Import Data`
2823
2. Select `Airtable`
2924

30-
![import data](/img/v2/base/base-import-from-dashboard-1.png)
31-
32-
![import from dashboard](/img/v2/base/base-import-from-dashboard-2.png)
25+
![import data](/img/v2/base/base-import-from-dashboard-1.png)
26+
![import from dashboard](/img/v2/base/base-import-from-dashboard-2.png)
3327

3428

35-
Continue with the following steps on `Import from Airtable` modal to complete the import process:
29+
## Configure details
30+
31+
Continue with the following steps on **Import from Airtable** modal to complete the import process:
3632
1. Input [Personal Access Token](#create-personal-access-token)
3733
2. Input [shared Base ID / URL](#retrieve-share-base-id--url)
3834
3. Use [Advanced settings](#advanced-settings) to configure import options (Optional)
@@ -85,16 +81,5 @@ See [here](https://support.airtable.com/hc/en-us/articles/205752117-Creating-a-b
8581

8682
![Shared base](/img/v2/base/airtable-share-base.png)
8783

88-
## Related articles
89-
- [Base overview](/docs/product-docs/bases)
90-
- [Create an empty base](/docs/product-docs/bases/create-base)
91-
- [Import base from Airtable](/docs/product-docs/bases/import-base-from-airtable)
92-
- [Invite team members to work on a base](/docs/product-docs/bases/base-collaboration)
93-
- [Share base publicly](/docs/product-docs/bases/share-base)
94-
- [Rename base](/docs/product-docs/bases/actions-on-base#rename-base)
95-
- [Duplicate base](/docs/product-docs/bases/actions-on-base#duplicate-base)
96-
- [Bookmark base](/docs/product-docs/bases/actions-on-base#star-base)
97-
- [Delete base](/docs/product-docs/bases/actions-on-base#delete-base)
98-
99-
84+
---
10085

0 commit comments

Comments
 (0)