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 fad54e27aa..d3709a2f83 100644 --- a/packages/noco-docs/docs/030.workspaces/020.create-workspace.md +++ b/packages/noco-docs/docs/030.workspaces/020.create-workspace.md @@ -17,7 +17,6 @@ In the following section, we will guide you through the process of creating your ![image](/img/v2/create-workspace-1.png) - ![image](/img/v2/create-workspace-2.png) 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 fc22d8396f..3a56dd7677 100644 --- a/packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md +++ b/packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md @@ -15,6 +15,10 @@ Next logical step after creating a workspace is to invite collaborators to it. I ![image](/img/v2/workspace-collaboration.png) +:::info +You can invite multiple collaborators at once by entering multiple email addresses separated by comma. +::: + ### List of collaborators List of the users who have access to the workspace is displayed on the same page. Refer **<1>** below. 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 ba4720cf8c..3158f6583c 100644 --- a/packages/noco-docs/docs/040.bases/020.create-base.md +++ b/packages/noco-docs/docs/040.bases/020.create-base.md @@ -5,3 +5,16 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ## Create base from scratch +1. Click on `+` on the left sidebar next to `projects` OR click on `+ New Project` button on the left sidebar. +2. Fill in the name of the base in the pop-up modal. +3. Click on `Create Database` button. + + +![image](/img/v2/create-base.png) +![image](/img/v2/create-base-2.png) + +:::info +- You will be marked as `base owner` on creation of the base. +- Only `base owner` has the authority to delete a base. +- You can create multiple bases within a workspace. +::: \ No newline at end of file diff --git a/packages/noco-docs/docs/040.bases/070.import-base-from-airtable.md b/packages/noco-docs/docs/040.bases/070.import-base-from-airtable.md index a09691c450..2ed3524d2d 100644 --- a/packages/noco-docs/docs/040.bases/070.import-base-from-airtable.md +++ b/packages/noco-docs/docs/040.bases/070.import-base-from-airtable.md @@ -1,5 +1,67 @@ --- -title: 'Import base from Airtable' +title: 'Import Airtable to NocoDB' +description: 'A complete import of your Airtable to any MySQL, Postgres, SQLite and SQL server databases within minutes' --- + import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; \ No newline at end of file +import TabItem from '@theme/TabItem'; + + +NocoDB allows a complete import of your Airtable base to any MySQL, Postgres, SQLite and SQL server databases within minutes. + +:::info +Import from Airtable is in beta version. See [Importing Airtable To NocoDB](https://github.com/nocodb/nocodb/discussions/2122) for the migration notes. +::: + +## Import Airtable to NocoDB + +:::info +Prerequisites:
- A NocoDB Base
- Airtable Credentials +::: + + +Below are 3 simple steps + +1. Go to your Base dashboard, click on `Import Data` + ![import data](https://github.com/nocodb/nocodb/assets/86527202/e5ca7748-5918-4fec-a2f5-6ffa7ab753f8) +2. Select `Airtable` + ![import data airtable](https://github.com/nocodb/nocodb/assets/86527202/c9f4aab6-4de3-4e24-808a-27d4f10104ce) +3. Input API key & Shared Base ID / URL (retrieved from `Get Airtable Credentials` above). + a. API Key + b. Share Base ID + c. Configuration option + `Import Data`: disable this option to import only table & view schema's + `Import Secondary Views`: disable this option to import only primary grid view per table + `Import Rollup Columns`: disable this option to skip Rollup column import + `Import Lookup Columns`: disable this option to skip Lookup column import + `Import Attachments Columns`: disable this option to skip Attachment column import + `Import Formula Columns`: disable this option to skip Formula column import (Not available yet) + + ![Screenshot 2022-09-14 at 9 30 14 AM](https://user-images.githubusercontent.com/86527202/190057133-92807b16-4f2b-4c58-8bae-a2cfe677ee62.png) +4. Click `Import` and you will see the status +5. Wait until `Go To Dashboard` button is activated on the modal. Import details are captured in log window. + ![Screenshot 2022-09-14 at 9 33 42 AM](https://user-images.githubusercontent.com/86527202/190057152-be9ec6cb-e414-465c-8967-d1ad40478ce1.png) + + +## Get Airtable Credentials + +:::info +You need to retrieve API key and Shared Base ID / URL from Airtable. +::: + +### Retrieve API Key +- Copy your Airtable API Key from [Airtable Accounts](https://airtable.com/account) page + ![Screenshot 2022-05-16 at 1 50 07 PM](https://user-images.githubusercontent.com/86527202/168569905-48c16d6d-c44a-4337-be49-0ac3dc1f7b75.png) + +### Retrieve Share Base ID / URL + +See [here](https://support.airtable.com/hc/en-us/articles/205752117-Creating-a-base-share-link-or-a-view-share-link#basesharelink) for detailed procedures. + +1. Open `Share` menu in your Project / Base + ![Screenshot 2022-05-16 at 3 47 27 PM](https://user-images.githubusercontent.com/86527202/168572054-533b8c19-d76e-4add-b876-f1e0570ac33c.png) +2. Open tab `Share Publicly` +3. Enable `Turn on full base access` +4. Copy generated shared base URL + ![Screenshot 2022-05-16 at 3 41 54 PM](https://user-images.githubusercontent.com/86527202/168572062-5dee065d-2394-426d-8f43-77ecc0c9b73f.png) + + diff --git a/packages/noco-docs/docs/040.bases/075.base-collaboration.md b/packages/noco-docs/docs/040.bases/075.base-collaboration.md index e69de29bb2..cbbd5befa9 100644 --- a/packages/noco-docs/docs/040.bases/075.base-collaboration.md +++ b/packages/noco-docs/docs/040.bases/075.base-collaboration.md @@ -0,0 +1,18 @@ +--- +title: 'Base Collaboration' +--- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Invite collaborators to your base by following simple steps below: +1. Click on `Base name` on the left sidebar to open `Base Dashboard`. +2. Select `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/invite-collaborators.png) + +:::info +You can invite multiple collaborators at once by entering multiple email addresses separated by comma. +::: \ No newline at end of file diff --git a/packages/noco-docs/docs/040.bases/080.delete-base.md b/packages/noco-docs/docs/040.bases/080.delete-base.md index 7d76f60737..a7c3ca5c25 100644 --- a/packages/noco-docs/docs/040.bases/080.delete-base.md +++ b/packages/noco-docs/docs/040.bases/080.delete-base.md @@ -2,4 +2,24 @@ title: 'Delete base' --- 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 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. + +:::danger +**This action cannot be undone.** +::: + +:::info +Only **base owner** can delete a workspace. +::: + +To delete a base: + +1. Open `base context menu` by clicking on the ellipses `...` next to base name` on the left sidebar. +2. From the dropdown, select `Delete` option. +3. Click on `Delete base` button on the confirmation dialog box. + +![image](/img/v2/base-delete.png) + +![image](/img/v2/base-delete-confirmation.png) diff --git a/packages/noco-docs/docs/040.bases/090.actions-on-base.md b/packages/noco-docs/docs/040.bases/090.actions-on-base.md index d774aad674..22899a580a 100644 --- a/packages/noco-docs/docs/040.bases/090.actions-on-base.md +++ b/packages/noco-docs/docs/040.bases/090.actions-on-base.md @@ -2,4 +2,60 @@ title: 'Actions on base' --- import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; \ No newline at end of file +import TabItem from '@theme/TabItem'; + +## Base context menu +Base context menu provides access to some of quick actions you can perform on a base. You can access base context menu by clicking on the ellipses `...` next to base name on the left sidebar. +![image](/img/v2/base-context-menu.png) + +## Rename base +You can rename a base by following simple steps below: +1. Open `base context menu` by clicking on the ellipses `...` next to base name` on the left sidebar. +2. From the dropdown, select `Rename` option. +3. Fill in the new name of the base inline, press `Enter` to save the new name. + +![image](/img/v2/rename-base-1.png) +![image](/img/v2/rename-base-2.png) + + +## Star (bookmark) a base +You can star a base by following simple steps below: +1. Open `base context menu` by clicking on the ellipses `...` next to base name` on the left sidebar. +2. From the dropdown, select `Add to Starred` option. +3. Base will be added to `Starred` section on the left sidebar. + +![image](/img/v2/starred-base-1.png) +![image](/img/v2/starred-base-2.png) + +:::info +Starred base will appear in both `Starred` section and `All Bases` section on the left sidebar. +::: + +### Remove a base from starred list +1. Open `base context menu` by clicking on the ellipses `...` next to base name` on the left sidebar. +2. From the dropdown, select `Remove from Starred` option. +3. Base will be removed from `Starred` section on the left sidebar. + +![image](/img/v2/starred-base-remove.png) + + +## Duplicate base +You can duplicate a base by following simple steps below: +1. Open `base context menu` by clicking on the ellipses `...` next to base name` on the left sidebar. +2. From the dropdown, select `Duplicate` option. +3. Optional configurations + a) You can choose to duplicate the base with or without data. + b) You can choose to duplicate the base with or without views. +4. Click on `Confirm` button on the confirmation modal. +5. New base will be created with the same schema and data/view as in the original base, based on configurations as specified in step (3). + +![image](/img/v2/duplicate-base-1.png) +![image](/img/v2/duplicate-base-2.png) +![image](/img/v2/duplicate-base-3.png) + +:::info +- Duplicate base will be created in the same workspace as the original base +- Duplicate base will carry suffix ` Copy` in its name. +- You will be marked as `base owner` on duplication of the base. +- Existing base collaborators are not migrated to the duplicated base. +::: diff --git a/packages/noco-docs/static/img/v2/base-context-menu.png b/packages/noco-docs/static/img/v2/base-context-menu.png new file mode 100644 index 0000000000..79d447646a Binary files /dev/null and b/packages/noco-docs/static/img/v2/base-context-menu.png differ diff --git a/packages/noco-docs/static/img/v2/base-delete-confirmation.png b/packages/noco-docs/static/img/v2/base-delete-confirmation.png new file mode 100644 index 0000000000..bf23d2c866 Binary files /dev/null and b/packages/noco-docs/static/img/v2/base-delete-confirmation.png differ diff --git a/packages/noco-docs/static/img/v2/base-delete.png b/packages/noco-docs/static/img/v2/base-delete.png new file mode 100644 index 0000000000..6c22e54c27 Binary files /dev/null and b/packages/noco-docs/static/img/v2/base-delete.png differ diff --git a/packages/noco-docs/static/img/v2/create-base-2.png b/packages/noco-docs/static/img/v2/create-base-2.png new file mode 100644 index 0000000000..652187c143 Binary files /dev/null and b/packages/noco-docs/static/img/v2/create-base-2.png differ diff --git a/packages/noco-docs/static/img/v2/create-base.png b/packages/noco-docs/static/img/v2/create-base.png new file mode 100644 index 0000000000..e635acbfd2 Binary files /dev/null and b/packages/noco-docs/static/img/v2/create-base.png differ diff --git a/packages/noco-docs/static/img/v2/duplicate-base-1.png b/packages/noco-docs/static/img/v2/duplicate-base-1.png new file mode 100644 index 0000000000..4481e63652 Binary files /dev/null and b/packages/noco-docs/static/img/v2/duplicate-base-1.png differ diff --git a/packages/noco-docs/static/img/v2/duplicate-base-2.png b/packages/noco-docs/static/img/v2/duplicate-base-2.png new file mode 100644 index 0000000000..c124a72236 Binary files /dev/null and b/packages/noco-docs/static/img/v2/duplicate-base-2.png differ diff --git a/packages/noco-docs/static/img/v2/duplicate-base-3.png b/packages/noco-docs/static/img/v2/duplicate-base-3.png new file mode 100644 index 0000000000..6cbe37a504 Binary files /dev/null and b/packages/noco-docs/static/img/v2/duplicate-base-3.png differ diff --git a/packages/noco-docs/static/img/v2/invite-collaborators.png b/packages/noco-docs/static/img/v2/invite-collaborators.png new file mode 100644 index 0000000000..a9a63df92b Binary files /dev/null and b/packages/noco-docs/static/img/v2/invite-collaborators.png differ diff --git a/packages/noco-docs/static/img/v2/rename-base-1.png b/packages/noco-docs/static/img/v2/rename-base-1.png new file mode 100644 index 0000000000..5f38d032dc Binary files /dev/null and b/packages/noco-docs/static/img/v2/rename-base-1.png differ diff --git a/packages/noco-docs/static/img/v2/rename-base-2.png b/packages/noco-docs/static/img/v2/rename-base-2.png new file mode 100644 index 0000000000..b5ea9ee2a6 Binary files /dev/null and b/packages/noco-docs/static/img/v2/rename-base-2.png differ diff --git a/packages/noco-docs/static/img/v2/starred-base-1.png b/packages/noco-docs/static/img/v2/starred-base-1.png new file mode 100644 index 0000000000..d4afdeff98 Binary files /dev/null and b/packages/noco-docs/static/img/v2/starred-base-1.png differ diff --git a/packages/noco-docs/static/img/v2/starred-base-2.png b/packages/noco-docs/static/img/v2/starred-base-2.png new file mode 100644 index 0000000000..9ad66cc7af Binary files /dev/null and b/packages/noco-docs/static/img/v2/starred-base-2.png differ diff --git a/packages/noco-docs/static/img/v2/starred-base-remove.png b/packages/noco-docs/static/img/v2/starred-base-remove.png new file mode 100644 index 0000000000..543c7dfe12 Binary files /dev/null and b/packages/noco-docs/static/img/v2/starred-base-remove.png differ