From 6e212a4d78177ef6019ef05601d3268d37245c35 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Tue, 22 Nov 2022 16:52:59 +0800 Subject: [PATCH 1/5] docs: minor meta changes --- .../content/en/engineering/development-setup.md | 15 ++++++++++----- .../en/engineering/repository-structure.md | 4 ++-- .../noco-docs/content/en/engineering/testing.md | 3 ++- .../content/en/setup-and-usages/views.md | 2 +- 4 files changed, 15 insertions(+), 9 deletions(-) diff --git a/packages/noco-docs/content/en/engineering/development-setup.md b/packages/noco-docs/content/en/engineering/development-setup.md index 67185ee9b0..6e773e8532 100644 --- a/packages/noco-docs/content/en/engineering/development-setup.md +++ b/packages/noco-docs/content/en/engineering/development-setup.md @@ -1,9 +1,9 @@ --- -title: "Development setup" +title: "Development Setup" description: "How to set-up your development environment" position: 3200 category: "Engineering" -menuTitle: "Development setup" +menuTitle: "Development Setup" --- ## Clone the repo @@ -13,6 +13,7 @@ cd nocodb/packages ``` ## Build SDK + ``` # build nocodb-sdk cd nocodb-sdk @@ -21,6 +22,7 @@ npm run build ``` ## Build Backend + ``` # build backend - runs on port 8080 cd ../nocodb @@ -29,6 +31,7 @@ npm run watch:run ``` ## Build Frontend + ``` # build frontend - runs on port 3000 cd ../nc-gui @@ -38,11 +41,13 @@ npm run dev Any changes made to frontend and backend will be automatically reflected in the browser. -## Enabling CI-CD for draft PR +## Enabling CI-CD for Draft PR + CI-CD will be triggered on moving a PR from draft state to `Ready for review` state & on pushing changes to `Develop`. To verify CI-CD before requesting for review, add label `trigger-CI` on Draft PR. -## Accessing CI-CD failure screenshots -For Cypress tests, screenshots are captured on test failure. These will provide vital clues for debugging possible issues observed in CI-CD. To access screenshots, Open link associated with CI-CD run & click on `Artifacts` +## Accessing CI-CD Failure Screenshots + +For Playwright tests, screenshots are captured on the tests. These will provide vital clues for debugging possible issues observed in CI-CD. To access screenshots, Open link associated with CI-CD run & click on `Artifacts` ![Screenshot 2022-09-29 at 12 43 37 PM](https://user-images.githubusercontent.com/86527202/192965070-dc04b952-70fb-4197-b4bd-ca7eda066e60.png) diff --git a/packages/noco-docs/content/en/engineering/repository-structure.md b/packages/noco-docs/content/en/engineering/repository-structure.md index 5f3a766134..b5b484ab3c 100644 --- a/packages/noco-docs/content/en/engineering/repository-structure.md +++ b/packages/noco-docs/content/en/engineering/repository-structure.md @@ -1,9 +1,9 @@ --- title: "Repository structure" -description: "Repository structure" +description: "Repository Structure" position: 3100 category: "Engineering" -menuTitle: "Repository structure" +menuTitle: "Repository Structure" --- We use ``Lerna`` to manage multi-packages. We have the following [packages](https://github.com/nocodb/nocodb/tree/master/packages). diff --git a/packages/noco-docs/content/en/engineering/testing.md b/packages/noco-docs/content/en/engineering/testing.md index 2ef027558c..ced2528d69 100644 --- a/packages/noco-docs/content/en/engineering/testing.md +++ b/packages/noco-docs/content/en/engineering/testing.md @@ -3,7 +3,7 @@ title: "Writing Tests" description: "Overview to testing" position: 3250 category: "Engineering" -menuTitle: "Testing" +menuTitle: "Writing Tests" --- ## Unit Tests @@ -36,6 +36,7 @@ Configure the following variables > DB_PASSWORD : password
### Run Tests + ``` bash npm run test:unit ``` diff --git a/packages/noco-docs/content/en/setup-and-usages/views.md b/packages/noco-docs/content/en/setup-and-usages/views.md index 3be469af84..a7d885656d 100644 --- a/packages/noco-docs/content/en/setup-and-usages/views.md +++ b/packages/noco-docs/content/en/setup-and-usages/views.md @@ -1,7 +1,7 @@ --- title: 'Views' description: 'Understanding Views in NocoDB!' -position: 600 +position: 700 category: 'Product' menuTitle: 'Views' --- From 93ec6892caaaa15fe73e5b44fa97a6b9f033f4d1 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Tue, 22 Nov 2022 16:53:26 +0800 Subject: [PATCH 2/5] docs: group team & settings together --- .../content/en/setup-and-usages/app-store.md | 13 +++++++++---- .../noco-docs/content/en/setup-and-usages/audit.md | 8 +++++--- .../content/en/setup-and-usages/meta-management.md | 4 ++-- .../content/en/setup-and-usages/team-and-auth.md | 7 ++++--- 4 files changed, 20 insertions(+), 12 deletions(-) diff --git a/packages/noco-docs/content/en/setup-and-usages/app-store.md b/packages/noco-docs/content/en/setup-and-usages/app-store.md index f0b518ed35..5e582c439f 100644 --- a/packages/noco-docs/content/en/setup-and-usages/app-store.md +++ b/packages/noco-docs/content/en/setup-and-usages/app-store.md @@ -1,17 +1,22 @@ --- -title: 'App Store' +title: 'Team & Settings > App Store' description: 'NocoDB provides different integrations in three main categories in App Store' -position: 1100 +position: 590 category: 'Product' -menuTitle: 'App Store' +menuTitle: 'Team & Settings > App Store' --- ## Overview +To access it, click the down arrow button next to Project Name on the top left side, then select `Team & Settings` and clicking `App Store`. + +image | image +|--|--| + We provide different integrations in three main categories. | Category | App Name | |---|---| | Chat | Microsoft Teams
Discord
Twilio
Whatsapp Twilio
Mattermost
Slack | | Email | SMTP
MailerSend
AWS SES | -| Storage | AWS S3
Minio
Google Cloud Storage
Spaces
Backblaze B2
Vultr Object Storage
OvhCloud Object Storage
Linode Object Storage
UpCloud Object Storage
Scaleway Object Storage | \ No newline at end of file +| Storage | AWS S3
Minio
Google Cloud Storage
Spaces
Backblaze B2
Vultr Object Storage
OvhCloud Object Storage
Linode Object Storage
UpCloud Object Storage
Scaleway Object Storage | diff --git a/packages/noco-docs/content/en/setup-and-usages/audit.md b/packages/noco-docs/content/en/setup-and-usages/audit.md index 7b472d61bd..23b3c0e96e 100644 --- a/packages/noco-docs/content/en/setup-and-usages/audit.md +++ b/packages/noco-docs/content/en/setup-and-usages/audit.md @@ -1,11 +1,13 @@ --- -title: 'Audit' +title: 'Team & Settings > Audit' description: 'NocoDB provides all the user operation logs under Audit log' -position: 590 +position: 610 category: 'Product' -menuTitle: 'Audit' +menuTitle: 'Team & Settings > Audit' --- +## Overview + We are keeping all the user operation logs under Audit. To access it, click the down arrow button next to Project Name on the top left side, then select `Team & Settings`. image diff --git a/packages/noco-docs/content/en/setup-and-usages/meta-management.md b/packages/noco-docs/content/en/setup-and-usages/meta-management.md index ff83a966fa..980b66e70d 100644 --- a/packages/noco-docs/content/en/setup-and-usages/meta-management.md +++ b/packages/noco-docs/content/en/setup-and-usages/meta-management.md @@ -1,9 +1,9 @@ --- -title: 'Metadata' +title: 'Team & Settings > Project Metadata' description: 'NocoDB Project Metadata' position: 600 category: 'Product' -menuTitle: 'Metadata' +menuTitle: 'Team & Settings > Project Metadata' --- Project Metadata includes Database Metadata, UI Access Control and Miscellaneous. diff --git a/packages/noco-docs/content/en/setup-and-usages/team-and-auth.md b/packages/noco-docs/content/en/setup-and-usages/team-and-auth.md index c8e36e559d..b6baf4bc04 100644 --- a/packages/noco-docs/content/en/setup-and-usages/team-and-auth.md +++ b/packages/noco-docs/content/en/setup-and-usages/team-and-auth.md @@ -1,12 +1,13 @@ --- -title: 'Team & Auth' +title: 'Team & Settings > Team & Auth' description: 'Breakdown of roles & permissions for team user management' -position: 630 +position: 580 category: 'Product' -menuTitle: 'Team & Auth' +menuTitle: 'Team & Settings > Team & Auth' --- # Accessing Team & Auth + - Click on `Team & Settings` from the `Project Menu` - Access `Team & Auth` under `Settings` From dc9f7cc72c97239df901dbc8f3f7a5e674ac668d Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Tue, 22 Nov 2022 16:53:57 +0800 Subject: [PATCH 3/5] docs: account settings ref: #4134 --- .../en/setup-and-usages/account-settings.md | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 packages/noco-docs/content/en/setup-and-usages/account-settings.md diff --git a/packages/noco-docs/content/en/setup-and-usages/account-settings.md b/packages/noco-docs/content/en/setup-and-usages/account-settings.md new file mode 100644 index 0000000000..8a33edb0db --- /dev/null +++ b/packages/noco-docs/content/en/setup-and-usages/account-settings.md @@ -0,0 +1,48 @@ +--- +title: 'Account Settings' +description: 'NocoDB provides Account Settings for managing your account or more for super admin' +position: 800 +category: 'Product' +menuTitle: 'Account Settings' +--- + +## Overview + +Account Settings allow you to manage your account such as your password or tokens. + +![image](https://user-images.githubusercontent.com/35857179/203260408-7767daec-a862-4b33-8a6a-6706bff01eb7.png) + +## Reset Password + +image + +## Token Management + +- Newly created tokens are associated with the created user and it will have all permissions that particular user has. +- Existing token will work as it is and only be visible to the super admin. + +image + +If you are a super admin, you can also manage all user roles in organization level. + +## User Management + +Super-admin has new privelege to do user management at root-level. + +- `org-level-creator` - this user can create a new project and access any invited project. + +- `org-level-viewer` - this user can't create a new project but they can access any invited project. + +![image](https://user-images.githubusercontent.com/35857179/203261168-5ba75f9c-476e-4fe7-ace4-f81051f42773.png) + +## Enable / Disable Signup + +Signup without an invitation is disabled by default and can be managed from UI by a super admin. + +![image](https://user-images.githubusercontent.com/35857179/203268555-a17fcd39-5fb9-448d-aeaf-e55cbf49f6c5.png) + +## App Store + +You can also manage the app store plugins here. + +![image](https://user-images.githubusercontent.com/35857179/203267619-24a8f5f5-1c8c-4419-a7a1-be4377fe6216.png) \ No newline at end of file From 67458ee0123e87d0a9d46bfaa358dd9028de3556 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Tue, 22 Nov 2022 17:08:31 +0800 Subject: [PATCH 4/5] docs: enter key to add row --- .../content/en/setup-and-usages/table-operations.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/packages/noco-docs/content/en/setup-and-usages/table-operations.md b/packages/noco-docs/content/en/setup-and-usages/table-operations.md index 4ef86ea55b..533e31180d 100644 --- a/packages/noco-docs/content/en/setup-and-usages/table-operations.md +++ b/packages/noco-docs/content/en/setup-and-usages/table-operations.md @@ -116,17 +116,24 @@ For adding new values to the table we need new rows, new rows can be added in tw - A new empty row will be created image +### Row Add (Pressing Enter Key from Previous Row) + +When you finish editing a cell and press Enter, the cell in the next row with the same column will be highlighted. + +![image](https://user-images.githubusercontent.com/35857179/203271676-bab64ca4-e0e4-4deb-9a62-609a97158911.png) + ### Row Edit You can start editing by any of the following methods - Double click on cell to edit - Click on cell and start typing (this way it will clear the previous content) - - Click on cell and press enter to start editing + - Click on cell and press enter to start editing - And it will automatically save on blur event or if inactive. ### Row Delete Right-click on anywhere in the row and then from the context menu select `Delete Row` option. + Bulk delete is also possible by selecting multiple rows by using the checkbox in first column and then `Delete Selected Rows` options from the right click context menu. image From 5bd4bd06882bb1404672ebcb6dbdabdec934c1a5 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Tue, 22 Nov 2022 17:26:54 +0800 Subject: [PATCH 5/5] docs: expanded form --- .../en/setup-and-usages/expanded-form.md | 39 +++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 packages/noco-docs/content/en/setup-and-usages/expanded-form.md diff --git a/packages/noco-docs/content/en/setup-and-usages/expanded-form.md b/packages/noco-docs/content/en/setup-and-usages/expanded-form.md new file mode 100644 index 0000000000..63e06a1e1f --- /dev/null +++ b/packages/noco-docs/content/en/setup-and-usages/expanded-form.md @@ -0,0 +1,39 @@ +--- +title: 'Expanded Form' +description: 'NocoDB provides Expanded Form to let you edit your data easily' +position: 1000 +category: 'Product' +menuTitle: 'Expanded Form' +--- + +## Overview + +Expanded Form allows you to edit a row data in a form. It also shows the activity feed such as user comments or revision history. It can be also shared by others by copying the record URL. + +![image](https://user-images.githubusercontent.com/35857179/203273340-987b1242-9c78-4195-9ca2-3d3c49c7bccf.png) + +## Expanding a Record + +In a grid view, we can hover a row record and a doulbe arrow will be shown. By clicking it, the expanded form will be opened. + +![image](https://user-images.githubusercontent.com/35857179/203274054-d20dc12b-7da8-4e6b-a144-19859b3c1c9c.png) + +Alternatively, we can highlight a cell and press the space bar. The expanded form for the correpsonding row will be opened. + +## Activity Feed + +In an expanded form, we can click `Toggle Comment View` button to show the activity feed where we can optionally filter out comments only. + +![image](https://user-images.githubusercontent.com/35857179/203275800-c8bc93f1-2a99-4766-8b81-70208c5675ca.png) + +## Copy Record URL + +In an expanded form, we can click `Copy Record URL` to share the record form to other authorized users. + +![image](https://user-images.githubusercontent.com/35857179/203276149-bc97c70a-8bbf-48b4-a3fb-dd437c9405d3.png) + +## Save Button Option + +By default, when we save the form, the expanded form will be closed, i.e. `Save & Exit`. However, if we prefer not to close the form even after saving, we can choose `Save & Stay` mode instead. This is useful when you are editing a long form and you want to save it from time to time. + +![image](https://user-images.githubusercontent.com/35857179/203276349-5d5c68d6-4523-41ae-8e23-312d2f6e9caa.png) \ No newline at end of file