github
/
nocodb
mirror of https://github.com/nocodb/nocodb
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

docs: revise content & updated screenshots 

#5149
refactor/icons-update
Wing-Kam Wong 2 years ago
parent
6ddbd6c46a
commit
b0a386cc3a
8 changed files with 62 additions and 99 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 18
      packages/noco-docs/content/en/developer-resources/accessing-apis.md
  2. 10
      packages/noco-docs/content/en/setup-and-usages/account-settings.md
  3. 22
      packages/noco-docs/content/en/setup-and-usages/app-store.md
  4. 7
      packages/noco-docs/content/en/setup-and-usages/dashboard.md
  5. 46
      packages/noco-docs/content/en/setup-and-usages/meta-management.md
  6. 6
      packages/noco-docs/content/en/setup-and-usages/project-settings.md
  7. 10
      packages/noco-docs/content/en/setup-and-usages/sync-schema.md
  8. 36
      packages/noco-docs/content/en/setup-and-usages/team-and-auth.md

18
packages/noco-docs/content/en/developer-resources/accessing-apis.md
Unescape View File

@ -18,23 +18,7 @@ Auth Token is a JWT Token generated based on the logged-in user. By default, the
## API Token ## API Token
NocoDB allows creating API tokens which allow it to be integrated seamlessly with 3rd party apps. API Token is a Nano ID with a length of 40. If you are passing API Token, make sure that the header is called `xc-token`. API tokens allows us to integrate seamlessly with 3rd party apps. See [API Tokens Management](../setup-and-usages/team-and-auth#api-tokens-management) for more.
- Open `Project Menu`, click on `Team & Settings`
<img width="322" alt="image" src="https://user-images.githubusercontent.com/35857179/194856648-67936db0-ee4d-4060-be3d-af9f86ef8fc6.png">
- Click `API Tokens Management` tab under `Team & Auth` section
- Click Add New Token
![Screenshot 2022-09-14 at 10 20 00 AM](https://user-images.githubusercontent.com/86527202/190062728-9c09934f-b5e4-4fec-b4d2-0cd3648bbb39.png)
- Type an recognizable name for your token and click `Generate`
![Screenshot 2022-09-14 at 10 20 10 AM](https://user-images.githubusercontent.com/86527202/190062801-db3fab83-7974-4dfe-9c83-bf0d8a7dba1e.png)
- Copy API token to your clipboard; use action menu to the right of token list
## Swagger UI ## Swagger UI

10
packages/noco-docs/content/en/setup-and-usages/account-settings.md
Unescape View File

@ -54,10 +54,16 @@ Signup without an invitation is disabled by default and can be managed from UI b
## App Store ## 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) ![image](https://user-images.githubusercontent.com/35857179/203267619-24a8f5f5-1c8c-4419-a7a1-be4377fe6216.png)
We provide different integrations in three main categories.
| Category | App Name |
|---|---|
| Chat | Microsoft Teams <br/> Discord <br/> Twilio <br/> Whatsapp Twilio<br/> Mattermost<br/> Slack |
| Email | SMTP<br/> MailerSend<br/> AWS SES |
| Storage | AWS S3 <br/> Minio <br/> Google Cloud Storage <br/> Spaces <br/> Backblaze B2 <br/> Vultr Object Storage <br/> OvhCloud Object Storage <br/> Linode Object Storage <br/> UpCloud Object Storage <br/> Scaleway Object Storage |
## License ## License
You can configure NocoDB Enterprise `License key` here You can configure NocoDB Enterprise `License key` here

22
packages/noco-docs/content/en/setup-and-usages/app-store.md
Unescape View File

@ -1,22 +0,0 @@
---
title: 'Team Settings > App Store'
description: 'NocoDB provides different integrations in three main categories in App Store'
position: 590
category: 'Product'
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 `Account Settings` and clicking `App Store`.
<img width="304" alt="Screenshot 2023-02-07 at 5 14 11 PM" src="https://user-images.githubusercontent.com/43586156/217380060-bc654146-233c-4f8a-9a7d-bb0d30a2eac9.png"> | <img width="200" alt="Screenshot 2023-02-07 at 5 14 30 PM" src="https://user-images.githubusercontent.com/43586156/217380195-dfe5de7f-0ad9-4af8-ba24-33805f72c32d.png">
|--|--|
We provide different integrations in three main categories.
| Category | App Name |
|---|---|
| Chat | Microsoft Teams <br/> Discord <br/> Twilio <br/> Whatsapp Twilio<br/> Mattermost<br/> Slack |
| Email | SMTP<br/> MailerSend<br/> AWS SES |
| Storage | AWS S3 <br/> Minio <br/> Google Cloud Storage <br/> Spaces <br/> Backblaze B2 <br/> Vultr Object Storage <br/> OvhCloud Object Storage <br/> Linode Object Storage <br/> UpCloud Object Storage <br/> Scaleway Object Storage |

7
packages/noco-docs/content/en/setup-and-usages/dashboard.md
Unescape View File

@ -45,18 +45,15 @@ Click on three-dot menu adjacent to `BASES`. Pick required database option from
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. 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.
</alert> </alert>
<!-- <img width="1500" alt="image" src="https://user-images.githubusercontent.com/35857179/194793497-3b740bf2-ffc7-48bf-836e-e4cd26631568.png"> -->
![Screenshot 2022-12-29 at 2 55 39 PM](https://user-images.githubusercontent.com/86527202/209933294-9327ff16-21db-4aca-bf16-8cea8a1eb415.png) ![Screenshot 2022-12-29 at 2 55 39 PM](https://user-images.githubusercontent.com/86527202/209933294-9327ff16-21db-4aca-bf16-8cea8a1eb415.png)
Above menu is also accessible from `Team & Settings` > `Data Sources`. Click on `New` button to add existing database. Above menu is also accessible from `Team & Settings` > `Data Sources`. Click on `New` button to add existing database.
![image](https://user-images.githubusercontent.com/35857179/219841162-6456c5cf-fd26-4a88-8de6-e8742c043607.png)
![Screenshot 2022-12-29 at 3 16 36 PM](https://user-images.githubusercontent.com/86527202/209936942-f82a293f-2e91-48da-b9cd-79ec143d7d6f.png)
You need to specify the project name, API type, and other database parameters. You need to specify the project name, API type, and other database parameters.
![Screenshot 2022-12-29 at 2 56 25 PM](https://user-images.githubusercontent.com/86527202/209933326-e76eee13-4942-4ba8-b184-a28099c089ab.png) ![image](https://user-images.githubusercontent.com/35857179/219841283-1a42f9f6-4677-4e25-8ca9-a060753d1e1e.png)
Currently it supports MySQL, Postgres, MSSQL and SQLite. Currently it supports MySQL, Postgres, MSSQL and SQLite.

46
packages/noco-docs/content/en/setup-and-usages/meta-management.md
Unescape View File

@ -6,6 +6,8 @@ category: 'Product'
menuTitle: 'Team & Settings > Data Sources' menuTitle: 'Team & Settings > Data Sources'
--- ---
## Overview
`Data Sources` sub-menu includes `Data Sources` sub-menu includes
- Database Metadata - Database Metadata
- UI Access Control - UI Access Control
@ -14,46 +16,33 @@ menuTitle: 'Team & Settings > Data Sources'
- Edit existing data source configuration - Edit existing data source configuration
- Edit data source visibility options - Edit data source visibility options
Note that, currently only one external data source can be added per project. Note that, currently only one external data source can be added per project.
To access it, click the down arrow button next to Project Name on the top left side, then select `Team & Settings` and clicking `Data Sources`. ## Accessing Data Sources
<!-- ![Screenshot 2022-12-29 at 4 26 27 PM](https://user-images.githubusercontent.com/86527202/209941709-1bfdbb01-ebd0-4c85-a966-2a8b4fc6ade7.png) -->
![Screenshot 2022-12-29 at 4 29 24 PM](https://user-images.githubusercontent.com/86527202/209941906-a9c8d48d-d604-4a2f-8ffb-7a9a494bac6b.png)
![Screenshot 2022-12-29 at 4 27 14 PM](https://user-images.githubusercontent.com/86527202/209941716-70f2aaa7-b035-42b2-835e-eb2ca348be42.png)
To access it, click the down arrow button next to Project Name on the top left side, then select `Team & Settings` and clicking `Data Sources`.
<!-- ![Screenshot 2022-12-29 at 3 54 55 PM](https://user-images.githubusercontent.com/86527202/209938195-7384b4d8-0289-447f-bd39-1ec600cd1723.png) --> <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/86527202/209941709-1bfdbb01-ebd0-4c85-a966-2a8b4fc6ade7.png"> | <img alt="image" src="https://user-images.githubusercontent.com/86527202/209941716-70f2aaa7-b035-42b2-835e-eb2ca348be42.png"> -->
<!-- |--|--| -->
![Screenshot 2022-12-29 at 4 15 00 PM](https://user-images.githubusercontent.com/86527202/209940452-5b867b71-b9f1-4e64-af69-14715ab73be7.png)
![image](https://user-images.githubusercontent.com/35857179/219833316-1fb234f0-583f-4ab8-b8d7-a6e249e7cd97.png)
## Sync Metadata ## Sync Metadata
Go to `Data Sources`, click ``Sync Metadata``, you can see your metadata sync status. If it is out of sync, you can sync the schema. See <a href="./sync-schema">Sync Schema</a> for more.0 Go to `Data Sources`, click ``Sync Metadata``, you can see your metadata sync status. If it is out of sync, you can sync the schema. See <a href="./sync-schema">Sync Schema</a> for more.0
![Screenshot 2022-12-29 at 4 19 35 PM](https://user-images.githubusercontent.com/86527202/209940903-396650b4-e219-494a-863f-c3f1beb51c5e.png) ![image](https://user-images.githubusercontent.com/35857179/219833485-3bcaa6ec-88bc-47cc-b938-5abb4835dc31.png)
<!-- <img width="1333" alt="image" src="https://user-images.githubusercontent.com/35857179/194850034-5330458e-85a9-4a3c-87a3-dd2f3edc5b46.png"> -->
## UI Access Control ## UI Access Control
Go to `Data Sources`, click ``UI ACL``, you can control the access to each table by roles. Go to `Data Sources`, click ``UI ACL``, you can control the access to each table by roles.
<!-- <img width="1336" alt="image" src="https://user-images.githubusercontent.com/35857179/194850281-9030f4c5-06bc-4780-b8fd-5d0c209867e0.png"> --> ![image](https://user-images.githubusercontent.com/35857179/219833072-20e9f4ad-fd1c-4e96-9112-6edda1447ec6.png)
![Screenshot 2022-12-29 at 4 20 57 PM](https://user-images.githubusercontent.com/86527202/209941141-deed80a9-7682-48e1-8de9-9c965c990d2d.png)
## ERD ## ERD
Go to `Data Sources`, click ``ERD``, you can see the ERD of your database. Go to `Data Sources`, click ``ERD``, you can see the ERD of your database.
![Screenshot 2022-12-29 at 4 21 55 PM](https://user-images.githubusercontent.com/86527202/209941168-b53d2898-8448-47fa-a8b3-6f3572f6b3a2.png) ![image](https://user-images.githubusercontent.com/35857179/219832288-f6266544-a259-4667-95d9-0e5ce7ac5d27.png)
<!-- <img width="1338" alt="image" src="https://user-images.githubusercontent.com/35857179/194850416-54bc49cf-c32f-45e8-aea1-62b07645c26e.png"> -->
### Junction table names within ERD ### Junction table names within ERD
@ -61,32 +50,23 @@ Go to `Data Sources`, click ``ERD``, you can see the ERD of your database.
- Double click on `Show Columns` to see additional checkboxes get enabled. - Double click on `Show Columns` to see additional checkboxes get enabled.
- Enabling which you should be able to see junction tables and their table names. - Enabling which you should be able to see junction tables and their table names.
<img width="1681" alt="Show Junction table names for many to many table" src="https://user-images.githubusercontent.com/5435402/192140913-9da37700-28fe-404d-88e8-35ba0c8e2f53.png"> ![image](https://user-images.githubusercontent.com/35857179/219832436-9c1311c3-854c-4b31-9c94-8035dfba2a2b.png)
## Edit external database configuration parameters ## Edit external database configuration parameters
Go to `Data Sources`, click ``Edit``, you can re-configure database credentials. Go to `Data Sources`, click ``Edit``, you can re-configure database credentials.
Please make sure database configuration parameters are valid. Any incorrect parameters could lead to schema loss! Please make sure database configuration parameters are valid. Any incorrect parameters could lead to schema loss!
![image](https://user-images.githubusercontent.com/35857179/219832592-14209cbf-d980-4e14-9a59-bda1b778a74e.png)
![Screenshot 2022-12-29 at 4 22 08 PM](https://user-images.githubusercontent.com/86527202/209941211-de9670c9-a73c-4719-9957-eeaf05f3a7ee.png)
## Unlink data source ## Unlink data source
Go to `Data Sources`, click ``Delete`` against the data source that you wish to un-link. Go to `Data Sources`, click ``Delete`` against the data source that you wish to un-link.
![Screenshot 2022-12-29 at 4 31 16 PM](https://user-images.githubusercontent.com/86527202/209942178-5ae40f14-0e87-41f7-9630-e2bf6f59a906.png) ![image](https://user-images.githubusercontent.com/35857179/219832810-a3e9ed88-f732-4f30-9228-ff782be0b9d6.png)
## Data source visibility ## Data source visibility
Go to `Data Sources`, toggle ``Radio-button`` against the data source that you wish to hide/un-hide. Go to `Data Sources`, toggle ``Radio-button`` against the data source that you wish to hide/un-hide.
![Screenshot 2022-12-29 at 4 31 16 PM 2](https://user-images.githubusercontent.com/86527202/209942198-627f7f14-761b-4709-b9ca-fde5111fa207.png) ![image](https://user-images.githubusercontent.com/35857179/219832914-f485099c-423f-4df8-bf00-b509288efe6d.png)
<!-- ## Miscellaneous
- Enabling, `Show M2M Tables` will show junction tables between many to many tables.
<img width="1340" alt="image" src="https://user-images.githubusercontent.com/35857179/194850461-3e88752a-ba4f-4ead-9426-9a9e57020061.png">
-->

6
packages/noco-docs/content/en/setup-and-usages/project-settings.md
Unescape View File

@ -14,8 +14,4 @@ Generic project configuration options are retained under `Project Settings` menu
Then, under SETTINGS, click `Project Settings`. Then, under SETTINGS, click `Project Settings`.
## Miscellaneous ![image](https://user-images.githubusercontent.com/35857179/219830971-9518fa21-a45c-4d49-af3f-2f933d779ecd.png)
- Enabling, `Show M2M Tables` will show junction tables between many to many tables.
![Screenshot 2022-12-29 at 7 05 04 PM](https://user-images.githubusercontent.com/86527202/209961654-ffe8ddc6-c7e2-4c0d-9762-2b57fb883cfa.png)

10
packages/noco-docs/content/en/setup-and-usages/sync-schema.md
Unescape View File

@ -16,17 +16,19 @@ Below are the steps to sync schema changes.
<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">
### 2. Click `Project Metadata` under SETTINGS, access `Metadata` tab ### 2. Click `Data Source` under SETTINGS, click `Sync Metadata` on the target base
<img width="1333" alt="image" src="https://user-images.githubusercontent.com/35857179/194850034-5330458e-85a9-4a3c-87a3-dd2f3edc5b46.png"> ![image](https://user-images.githubusercontent.com/35857179/219831352-e6692ba5-5c94-4331-94ce-5796e57f87a1.png)
![image](https://user-images.githubusercontent.com/35857179/219831634-bbb6f256-45fb-4224-9f82-bc1bed6082db.png)
### 3. Changes carried outside GUI, identified by NocoDB are listed under `Sync state` ### 3. Changes carried outside GUI, identified by NocoDB are listed under `Sync state`
- If changes made to the database are not visible, click `Reload` - If changes made to the database are not visible, click `Reload`
- Identified schema changes are identified for each table in `red` - Identified schema changes are identified for each table in `red`
- `Sync now` button gets activated, if Schema changes are identified by NocoDB - `Sync now` button gets activated, if Schema changes are identified by NocoDB
![Screenshot 2022-09-13 at 10 42 12 AM](https://user-images.githubusercontent.com/86527202/189814648-ca28f28d-b0ed-4652-a5da-e6472bfd9407.png) ![image](https://user-images.githubusercontent.com/35857179/219831855-bcac229c-41b6-4689-b7e1-c3cdfe23a0a1.png)
<!-- ![image](https://user-images.githubusercontent.com/35857179/161957119-f66f22ad-9d37-45ed-84ca-35c99726078c.png) -->
### 4. Click `Sync Now` to complete Schema sync procedure ### 4. Click `Sync Now` to complete Schema sync procedure

36
packages/noco-docs/content/en/setup-and-usages/team-and-auth.md
Unescape View File

@ -6,18 +6,21 @@ category: 'Product'
menuTitle: 'Team & Settings > 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`
<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">
## How to Add a User ## User Management
### How to Add a User
1. Go to `Team & Auth`, click on `Invite Team` 1. Go to `Team & Auth`, click on `Invite Team`
<img width="1336" alt="image" src="https://user-images.githubusercontent.com/35857179/194849838-f936128a-3f8a-46ef-a4e3-fdc14b633874.png"> ![image](https://user-images.githubusercontent.com/35857179/219830800-481f372f-86b1-4e2f-865d-3fb7c10663f7.png)
2. Enter the user's `E-mail`. Select `User Role`, and Click `Invite`. 2. Enter the user's `E-mail`. Select `User Role`, and Click `Invite`.
@ -32,18 +35,16 @@ If you do not have an SMTP sender configured, make sure to copy the invite link
![Screenshot 2022-09-13 at 10 54 22 AM](https://user-images.githubusercontent.com/86527202/189817156-f3dab634-dc25-4f9b-8126-865187aae254.png) ![Screenshot 2022-09-13 at 10 54 22 AM](https://user-images.githubusercontent.com/86527202/189817156-f3dab634-dc25-4f9b-8126-865187aae254.png)
## How to Update user permissions ### How to Update user permissions
1. Use `Edit` <1> menu to assign a different role to existing user 1. Use `Edit` <1> menu to assign a different role to existing user
2. Use `Delete` <2> menu to remove a user from accessing current project 2. Use `Delete` <2> menu to remove a user from accessing current project
![Screenshot 2022-09-13 at 11 06 16 AM](https://user-images.githubusercontent.com/86527202/189818302-80a05245-9dc1-4364-b380-7bd698e5b9e0.png) ![image](https://user-images.githubusercontent.com/35857179/219830858-be7a4656-9f3b-440c-9a79-165f919223d7.png)
------ ------
### User Role Permissions
# User Role Permissions
### Advanced Options & Configurations ### Advanced Options & Configurations
| &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; | &nbsp; &nbsp; Owner &nbsp; &nbsp;| &nbsp; &nbsp; Creator &nbsp; &nbsp; | &nbsp; &nbsp; Editor &nbsp; &nbsp;| Commenter | &nbsp; &nbsp; Viewer &nbsp; &nbsp;| | &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; | &nbsp; &nbsp; Owner &nbsp; &nbsp;| &nbsp; &nbsp; Creator &nbsp; &nbsp; | &nbsp; &nbsp; Editor &nbsp; &nbsp;| Commenter | &nbsp; &nbsp; Viewer &nbsp; &nbsp;|
@ -106,6 +107,25 @@ If you do not have an SMTP sender configured, make sure to copy the invite link
| Project Info | ✅ | ✅ | ✅ | ✅ | ✅ | | Project Info | ✅ | ✅ | ✅ | ✅ | ✅ |
| Swagger API | ✅ | ✅ | ✅ | ✅ | ✅ | | Swagger API | ✅ | ✅ | ✅ | ✅ | ✅ |
## API Tokens Management
NocoDB allows creating API tokens which allow it to be integrated seamlessly with 3rd party apps. API Token is a Nano ID with a length of 40. If you are passing API Token, make sure that the header is called `xc-token`.
- Open `Project Menu`, click on `Team & Settings`
<img width="322" alt="image" src="https://user-images.githubusercontent.com/35857179/194856648-67936db0-ee4d-4060-be3d-af9f86ef8fc6.png">
- Click `API Tokens Management` tab under `Team & Auth` section
- Click Add New Token
![image](https://user-images.githubusercontent.com/35857179/219835108-037127bd-4bf6-4d96-b691-139bd141631c.png)
- Type an recognizable name for your token and click `Generate`
![Screenshot 2022-09-14 at 10 20 10 AM](https://user-images.githubusercontent.com/86527202/190062801-db3fab83-7974-4dfe-9c83-bf0d8a7dba1e.png)
- Copy API token to your clipboard; use action menu to the right of token list
<!-- TODO: --> <!-- TODO: -->
<!-- ### Automations <!-- ### Automations

Write Preview
Loading…
Cancel
Save