From fbc30b00e982c434124dc022c77f650b1476ef64 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Thu, 8 Sep 2022 14:16:13 +0800 Subject: [PATCH] docs: update content and screenshots for dashboard page --- .../content/en/setup-and-usages/dashboard.md | 36 ++++++++----------- 1 file changed, 15 insertions(+), 21 deletions(-) diff --git a/packages/noco-docs/content/en/setup-and-usages/dashboard.md b/packages/noco-docs/content/en/setup-and-usages/dashboard.md index 21bcbd1aec..7adc4aeaae 100644 --- a/packages/noco-docs/content/en/setup-and-usages/dashboard.md +++ b/packages/noco-docs/content/en/setup-and-usages/dashboard.md @@ -8,60 +8,54 @@ menuTitle: 'Dashboard' ## Setup Your First Super Admin -Once you have started NocoDB, you can visit the dashboard via `example.com/dashboard`. - -Click `Let's Begin` button to sign up. - -![image](https://user-images.githubusercontent.com/35857179/163138119-be4314f9-22eb-4df6-b0af-b6990c563795.png) +Once you have started NocoDB, you can visit the dashboard via `example.com`. You will be redirected to `example.com/#/signup`. Enter your work email and your password. +image + Your password has at least 8 letters with one uppercase, one number and one special letter -![image](https://user-images.githubusercontent.com/35857179/163138460-59ddd93f-a8ef-4c02-8b7b-037a53cefd77.png) - ## Initialize Your First Project Once you have logged into NocoDB, you should see `My Projects`. -![image](https://user-images.githubusercontent.com/35857179/163135335-652470ee-f69e-4b12-8884-63e8056bfce3.png) +image -To create a project, you can click `New Project`. +To create a project, you can click `New Project`. You can choose create an empty project or a project connecting to an external database. -![image](https://user-images.githubusercontent.com/35857179/167252813-84876756-f6a1-488a-a185-cbb09f163c5b.png) +image ### Creating Empty Project -Click `Create`, you need to specify the project name and API type. +Click `Create Project`, you need to specify the project name. The data will be stored in `NC_DB`. If it is not specified, a local SQLite will be created and used. -A local SQLite will be used. +NC_DB is an environment variable used to store the meta data in the given database. -![image](https://user-images.githubusercontent.com/35857179/163135608-5e135a73-afcd-40bb-9d26-f2970dab7143.png) +image ### Connecting to External Database Click `Create By Connecting To An External Database`, you need to specify the project name, API type, and other database parameters. -Tip 1: If you are running NocoDB on Docker and your local DB is running on your host machine, your Host Address would be host.docker.internal instead of localhost. +Tip: If you are running NocoDB on Docker and your local DB is running on your host machine, your Host Address would be host.docker.internal instead of localhost. -![image](https://user-images.githubusercontent.com/35857179/163135736-d209061e-893d-4441-aaaa-ff22a1c82ceb.png) +image Currently it supports MySQL, Postgres, MSSQL and SQLite. -![image](https://user-images.githubusercontent.com/35857179/126597320-fd6b19a9-ed3e-4f4a-80b7-880a79a54a11.png) - You can also configure associated SSL & advanced parameters. -![image](https://user-images.githubusercontent.com/35857179/163135911-04e01016-0ffd-4f38-83a8-c667bd268759.png) +image -Tip 2: You can click Edit Connection JSON and modify SSL settings in "ssl". +Tip: You can click Edit Connection JSON and modify SSL settings in "ssl". ```json @@ -83,7 +77,7 @@ Tip 2: You can click Edit Connection JSON and modify SSL settings in "ssl". ``` -Tip 3: You can click Edit Connection JSON and specify the schema you want to use in "searchPath". +Tip: You can click Edit Connection JSON and specify the schema you want to use in "searchPath". ```json @@ -98,4 +92,4 @@ Tip 3: You can click Edit Connection JSON and specify the schema you want to use Click `Test Database Connection` to see if the connection can be established or not. NocoDB creates a new **empty database** with specified parameters if the database doesn't exist. -![image](https://user-images.githubusercontent.com/35857179/163136039-ad521d74-6996-4173-84ba-cfc55392c3b7.png) +image