Browse Source

docs: team & settings

Signed-off-by: Wing-Kam Wong <wingkwong.code@gmail.com>
pull/1671/head
Wing-Kam Wong 3 years ago
parent
commit
05ee070973
  1. 6
      packages/noco-docs/content/en/setup-and-usages/audit.md
  2. 40
      packages/noco-docs/content/en/setup-and-usages/meta-management.md
  3. 37
      packages/noco-docs/content/en/setup-and-usages/sync-schema.md

6
packages/noco-docs/content/en/setup-and-usages/audit.md

@ -6,12 +6,12 @@ category: 'Product'
menuTitle: 'Audit'
---
We are keeping all the user operation logs under audits, user can access the audits logs by clicking the `Audit` icon from the left navigation drawer.
We are keeping all the user operation logs under Audit. Audits logs can be accessed by clicking `Team & Settings` from the left navigation drawer and clicking `Audit`.
<!-- TODO: update screenshot -->
![Screenshot_2021-07-23_at_7_08_22_PM](https://user-images.githubusercontent.com/61551451/126790439-14f4f60e-f125-48f8-a8a5-28f20fab71aa.png)
_Sample audit logs:_
<!-- TODO: update screenshot -->
![Pasted_Image_23_07_21__7_13_PM](https://user-images.githubusercontent.com/61551451/126790664-024f4803-c343-46ca-9b47-c3dfa0b1ad6c.png)

40
packages/noco-docs/content/en/setup-and-usages/meta-management.md

@ -6,7 +6,10 @@ category: 'Product'
menuTitle: 'Metadata'
---
To go to the Meta Management Portal, click ``Project Metadata`` under ``Settings`` on the leftmost menu.
Project Metadata can be found by clicking `Team & Settings` from the left navigation drawer and clicking `Project Metadata`.
<!-- TODO: update screenshot -->
![image](https://user-images.githubusercontent.com/35857179/126929430-1ad086a8-0611-4f39-8c7f-580637574056.png)
@ -31,34 +34,41 @@ Under ``Project Metadata``, you can perform the following operations.
Import / Export will only transfer metadata and files related to the project and not any table data in the project.
</alert>
## Migration example
### Export metadata
Source project : Under ``Meta Management`` tab, select ``Export zip``, click ``Submit``. This step extracts project metadata and stores it in compressed (zip) format
## Migration Example
### Export Metadata
Source project : Under ``Export / Import Metadata`` tab, select ``Export zip``, click ``Submit``.
This step extracts project metadata and stores it in compressed (zip) format.
<!-- TODO: update screenshot -->
![meta-dev](https://user-images.githubusercontent.com/86527202/130780497-89578bd0-a417-468a-92d8-88c5c07a72b0.png "Step-Export")
### Import metadata
Destination project : Under ``Meta Management`` tab, select ``Import zip``, select ``meta.zip`` file stored in previous step. This step imports project metadata from compressed file (zip) selected and restarts project.
### Import Metadata
![meta-prod](https://user-images.githubusercontent.com/86527202/130781015-3477e596-b1bc-4189-9853-bfd850157ba8.png)
Destination project : Under ``Export / Import Metadata`` tab, select ``Import zip``, select ``meta.zip`` file stored in previous step.
---
This step imports project metadata from compressed file (zip) selected and restarts project.
<!-- TODO: update screenshot -->
![meta-prod](https://user-images.githubusercontent.com/86527202/130781015-3477e596-b1bc-4189-9853-bfd850157ba8.png)
## Database Metadata
Under ``DB Metadata``, You can manage your models. For example, if you do not want to expose some APIs, you can untick those under APIs here.
Under ``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.
![image](https://user-images.githubusercontent.com/35857179/127611038-a10ccee5-72ca-42cf-a55b-c8268c9fbe5c.png)
<!-- TODO: update screenshot -->
The relations of all tables are listed under ``Relations``.
![image](https://user-images.githubusercontent.com/35857179/127611116-0289f739-bad7-45a0-b2bd-bfd8565f50b8.png)
![image](https://user-images.githubusercontent.com/35857179/127611038-a10ccee5-72ca-42cf-a55b-c8268c9fbe5c.png)
## UI Access Control
You can control the access to each table and relation by roles.
Under ``UI Access Control``, you can control the access to each table by roles.
<!-- TODO: update screenshot -->
![image](https://user-images.githubusercontent.com/35857179/127611188-339de6ca-e648-47c0-a358-eee0d03ae9d0.png)
![image](https://user-images.githubusercontent.com/35857179/127611237-5c43e194-a8ba-4e33-b473-5b690a38e80d.png)

37
packages/noco-docs/content/en/setup-and-usages/sync-schema.md

@ -6,21 +6,36 @@ category: 'Product'
menuTitle: 'Sync Schema'
---
## How to sync schema changes to NocoDB.
NocoDB allows you to sync schema changes if you have made changes outside NocoDB GUI. However, it has to be noted then you will have to bring your own
schema migrations for moving from environment to other.
## How to sync schema changes to NocoDB
NocoDB allows you to sync schema changes if you have made changes outside NocoDB GUI. However, it has to be noted then you will have to bring your own schema migrations for moving from environment to others.
Below are the steps to sync schema changes.
1. Under `Settings` menubar, click `Project Metadata`
2. Under `Meta Management` tab, click on `Metadata` sub tab.
3. Changes carried outside GUI, identified by NocoDB are listed under `Sync state`
4. Click `Sync Now` to complete Schema sync procedure.
![metasync](https://user-images.githubusercontent.com/86527202/147923717-630f0e0f-7c7a-431c-a50d-8f9376a06eb7.png)
### 1. From the menu bar, click `Team & Settings`
<!-- TODO: add screenshot -->
### 2. Click `Project Metadata` under SETTINGS
<!-- TODO: add screenshot -->
### 3. Under `Metadata` tab, click on `Metadata` sub tab
<!-- TODO: add screenshot -->
### 4. Changes carried outside GUI, identified by NocoDB are listed under `Sync state`
<!-- TODO: add screenshot -->
### 5. Click `Sync Now` to complete Schema sync procedure
<!-- TODO: add screenshot -->
#### Notes
## Note
1. Column rename operation will be treated like 'column delete' & 'column create' operation
2. Only table schema changes identified will be listed under `Sync state`; any changes to records are automatically synchronized.
1. Column rename operation will be treated like `column delete` & `column create` operation.
2. Only table schema changes identified will be listed under `Sync state`. Any changes to records are automatically synchronized.

Loading…
Cancel
Save