Browse Source

Merge pull request #4461 from nocodb/docs/nocodb-documentation

docs: nocodb documentation
pull/4465/head
Raju Udava 2 years ago committed by GitHub
parent
commit
f633b58341
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 15
      packages/noco-docs/content/en/engineering/development-setup.md
  2. 4
      packages/noco-docs/content/en/engineering/repository-structure.md
  3. 3
      packages/noco-docs/content/en/engineering/testing.md
  4. 48
      packages/noco-docs/content/en/setup-and-usages/account-settings.md
  5. 11
      packages/noco-docs/content/en/setup-and-usages/app-store.md
  6. 8
      packages/noco-docs/content/en/setup-and-usages/audit.md
  7. 39
      packages/noco-docs/content/en/setup-and-usages/expanded-form.md
  8. 4
      packages/noco-docs/content/en/setup-and-usages/meta-management.md
  9. 7
      packages/noco-docs/content/en/setup-and-usages/table-operations.md
  10. 7
      packages/noco-docs/content/en/setup-and-usages/team-and-auth.md
  11. 2
      packages/noco-docs/content/en/setup-and-usages/views.md

15
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" description: "How to set-up your development environment"
position: 3200 position: 3200
category: "Engineering" category: "Engineering"
menuTitle: "Development setup" menuTitle: "Development Setup"
--- ---
## Clone the repo ## Clone the repo
@ -13,6 +13,7 @@ cd nocodb/packages
``` ```
## Build SDK ## Build SDK
``` ```
# build nocodb-sdk # build nocodb-sdk
cd nocodb-sdk cd nocodb-sdk
@ -21,6 +22,7 @@ npm run build
``` ```
## Build Backend ## Build Backend
``` ```
# build backend - runs on port 8080 # build backend - runs on port 8080
cd ../nocodb cd ../nocodb
@ -29,6 +31,7 @@ npm run watch:run
``` ```
## Build Frontend ## Build Frontend
``` ```
# build frontend - runs on port 3000 # build frontend - runs on port 3000
cd ../nc-gui cd ../nc-gui
@ -38,11 +41,13 @@ npm run dev
Any changes made to frontend and backend will be automatically reflected in the browser. 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. 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 ## 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`
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) ![Screenshot 2022-09-29 at 12 43 37 PM](https://user-images.githubusercontent.com/86527202/192965070-dc04b952-70fb-4197-b4bd-ca7eda066e60.png)

4
packages/noco-docs/content/en/engineering/repository-structure.md

@ -1,9 +1,9 @@
--- ---
title: "Repository structure" title: "Repository structure"
description: "Repository structure" description: "Repository Structure"
position: 3100 position: 3100
category: "Engineering" 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). We use ``Lerna`` to manage multi-packages. We have the following [packages](https://github.com/nocodb/nocodb/tree/master/packages).

3
packages/noco-docs/content/en/engineering/testing.md

@ -3,7 +3,7 @@ title: "Writing Tests"
description: "Overview to testing" description: "Overview to testing"
position: 3250 position: 3250
category: "Engineering" category: "Engineering"
menuTitle: "Testing" menuTitle: "Writing Tests"
--- ---
## Unit Tests ## Unit Tests
@ -36,6 +36,7 @@ Configure the following variables
> DB_PASSWORD : password </br> > DB_PASSWORD : password </br>
### Run Tests ### Run Tests
``` bash ``` bash
npm run test:unit npm run test:unit
``` ```

48
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
<img width="1500" alt="image" src="https://user-images.githubusercontent.com/35857179/203267251-139fff32-38a9-4f39-af4f-c2c6ec5456bb.png">
## 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.
<img width="1506" alt="image" src="https://user-images.githubusercontent.com/35857179/203267432-352d3038-7784-4ea5-b521-1d0252ffbf70.png">
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)

11
packages/noco-docs/content/en/setup-and-usages/app-store.md

@ -1,13 +1,18 @@
--- ---
title: 'App Store' title: 'Team & Settings > App Store'
description: 'NocoDB provides different integrations in three main categories in App Store' description: 'NocoDB provides different integrations in three main categories in App Store'
position: 1100 position: 590
category: 'Product' category: 'Product'
menuTitle: 'App Store' menuTitle: 'Team & Settings > App Store'
--- ---
## Overview ## 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`.
<img width="322" alt="image" src="https://user-images.githubusercontent.com/35857179/194856648-67936db0-ee4d-4060-be3d-af9f86ef8fc6.png"> | <img width="471" alt="image" src="https://user-images.githubusercontent.com/35857179/203266301-064a6706-828b-457c-ab7b-868ba66d67e6.png">
|--|--|
We provide different integrations in three main categories. We provide different integrations in three main categories.
| Category | App Name | | Category | App Name |

8
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' description: 'NocoDB provides all the user operation logs under Audit log'
position: 590 position: 610
category: 'Product' 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`. 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`.
<img width="322" alt="image" src="https://user-images.githubusercontent.com/35857179/194856648-67936db0-ee4d-4060-be3d-af9f86ef8fc6.png"> <img width="322" alt="image" src="https://user-images.githubusercontent.com/35857179/194856648-67936db0-ee4d-4060-be3d-af9f86ef8fc6.png">

39
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)

4
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' description: 'NocoDB Project Metadata'
position: 600 position: 600
category: 'Product' category: 'Product'
menuTitle: 'Metadata' menuTitle: 'Team & Settings > Project Metadata'
--- ---
Project Metadata includes Database Metadata, UI Access Control and Miscellaneous. Project Metadata includes Database Metadata, UI Access Control and Miscellaneous.

7
packages/noco-docs/content/en/setup-and-usages/table-operations.md

@ -116,6 +116,12 @@ 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 - A new empty row will be created
<img width="567" alt="image" src="https://user-images.githubusercontent.com/35857179/189080009-3aeb70b4-92b0-4702-acb9-e5e52e31855e.png"> <img width="567" alt="image" src="https://user-images.githubusercontent.com/35857179/189080009-3aeb70b4-92b0-4702-acb9-e5e52e31855e.png">
### 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 ### Row Edit
You can start editing by any of the following methods You can start editing by any of the following methods
@ -127,6 +133,7 @@ You can start editing by any of the following methods
### Row Delete ### Row Delete
Right-click on anywhere in the row and then from the context menu select `Delete Row` option. 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. 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.
<img width="568" alt="image" src="https://user-images.githubusercontent.com/35857179/189081764-9f13c286-e02a-40d0-93ea-4b1362d96827.png"> <img width="568" alt="image" src="https://user-images.githubusercontent.com/35857179/189081764-9f13c286-e02a-40d0-93ea-4b1362d96827.png">

7
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' description: 'Breakdown of roles & permissions for team user management'
position: 630 position: 580
category: 'Product' category: 'Product'
menuTitle: 'Team & Auth' menuTitle: 'Team & Settings > Team & Auth'
--- ---
# Accessing Team & Auth # Accessing Team & Auth
- Click on `Team & Settings` from the `Project Menu` - Click on `Team & Settings` from the `Project Menu`
- Access `Team & Auth` under `Settings` - Access `Team & Auth` under `Settings`

2
packages/noco-docs/content/en/setup-and-usages/views.md

@ -1,7 +1,7 @@
--- ---
title: 'Views' title: 'Views'
description: 'Understanding Views in NocoDB!' description: 'Understanding Views in NocoDB!'
position: 600 position: 700
category: 'Product' category: 'Product'
menuTitle: 'Views' menuTitle: 'Views'
--- ---

Loading…
Cancel
Save