Browse Source

docs: revise Dashboard

Signed-off-by: Wing-Kam Wong <wingkwong.code@gmail.com>
pull/1671/head
Wing-Kam Wong 3 years ago
parent
commit
74cae0c2a6
  1. 65
      packages/noco-docs/content/en/setup-and-usages/dashboard.md

65
packages/noco-docs/content/en/setup-and-usages/dashboard.md

@ -6,7 +6,7 @@ category: 'Product'
menuTitle: 'Dashboard'
---
## Setup your first super admin
## Setup Your First Super Admin
Once you have started NocoDB, you can visit the dashboard via `example.com/dashboard`.
@ -22,7 +22,7 @@ Enter your work email and your password.
<img src="https://user-images.githubusercontent.com/35857179/126597144-0343b5ca-c7ca-47a4-926d-4e8df2f8c161.png" width="60%"/>
## Initialize your first project
## Initialize Your First Project
Once you have logged into NocoDB, you should see `My Projects`.
@ -34,15 +34,20 @@ To create a project, you can click `New Project`.
<img src="https://user-images.githubusercontent.com/86527202/144373314-9146e855-0791-4815-a03f-303e5ffb2a63.png" width="60%"/>
### Creating empty project
### Creating Empty Project
Click `Create`, you need to specify the project name and API type.
<alert>
A local SQLite will be used.
</alert>
Click `Create`, you need to specify the project name and API type. A local SQLite will be used.
<img src="https://user-images.githubusercontent.com/35857179/126597259-b9552c71-d13b-463c-abc2-0f3be31627b2.png" width="60%"/>
### Connecting to external database
### Connecting to External Database
Click `Create By Connecting To An external Datbase`, you need to specify the project name, API type, and other database parameters.
Click `Create By Connecting To An External Database`, you need to specify the project name, API type, and other database parameters.
![image](https://user-images.githubusercontent.com/35857179/126597279-c1722d8b-c885-4e9e-9e94-44711102af20.png)
@ -54,17 +59,53 @@ You can also configure associated SSL & advanced parameters.
![image](https://user-images.githubusercontent.com/35857179/126597342-0c61ab15-a112-4269-8f30-78455fa09081.png)
Click `Test Database Connection` to see if the connection can be established or not.
<alert type="success">
Tip 1: You can click Edit Connection JSON and modify SSL settings in "ssl".
</alert>
> NocoDB create's a new **empty database** with specified parameters, if the database doesn't exist.
```json
{
"client": "pg",
"connection": {
"host": "<YOUR_HOST>",
"port": "5432",
"user": "<YOUR_DB_USER>",
"password": "<YOUR_DB_PASSWORD>",
"database": "<YOUR_DB_NAME>",
"ssl": {
"require": true,
"rejectUnauthorized": false,
"sslMode": "no-verify"
}
}
}
```
<alert type="success">
Tip 2: You can click Edit Connection JSON and specify the schema you want to use in "searchPath".
</alert>
### Creating project from Excel
```json
{
"client": "pg",
"connection": {
...
},
"searchPath": [ "<YOUR_TARGET_SCHEMA>" ]
}
```
Click `Create Project from Excel`, you can either upload/ drag and drop Excel file (OR) specify Excel file URL
Click `Test Database Connection` to see if the connection can be established or not. NocoDB create's a new **empty database** with specified parameters, if the database doesn't exist.
### Creating Project from Excel
<img src="https://user-images.githubusercontent.com/86527202/144373863-7ced9315-a70b-4746-9295-325e463dc110.png" width="60%"/>
Click `Create Project from Excel`, you can either upload / drag and drop Excel file (OR) specify Excel file URL.
<alert>
A local SQLite will be used.
</alert>
<img src="https://user-images.githubusercontent.com/86527202/144373863-7ced9315-a70b-4746-9295-325e463dc110.png" width="60%"/>
Supported file formats
@ -74,5 +115,3 @@ Supported file formats
- Ods
- Ots
A local SQLite will be used.

Loading…
Cancel
Save