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

docs: update screenshots 

Signed-off-by: Wing-Kam Wong <wingkwong.code@gmail.com>
pull/1671/head
Wing-Kam Wong 3 years ago
parent
84e5690b49
commit
e044728920
6 changed files with 25 additions and 30 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 8
      packages/noco-docs/content/en/FAQs.md
  2. 4
      packages/noco-docs/content/en/developer-resources/accessing-apis.md
  3. 19
      packages/noco-docs/content/en/developer-resources/api-tokens.md
  4. 10
      packages/noco-docs/content/en/setup-and-usages/audit.md
  5. 4
      packages/noco-docs/content/en/setup-and-usages/share-base.md
  6. 10
      packages/noco-docs/content/en/setup-and-usages/sync-schema.md

8
packages/noco-docs/content/en/FAQs.md
Unescape View File

@ -23,17 +23,13 @@ menuTitle: 'FAQs'
- You can hover the NocoDB icon on the top left corner or check ``PackageVersion`` in Project info.
<!-- TODO: update screenshot -->
![image](https://user-images.githubusercontent.com/35857179/127765903-3ae876ad-6b46-4520-9d11-679b80eb7b08.png)
![image](https://user-images.githubusercontent.com/35857179/161957765-922058dc-dba1-44c5-95f4-2924c875e1c6.png)
## How to check my Project info ?
- You can click on top right icon and click ``Copy Project Info``.
<!-- TODO: update screenshot -->
![image](https://user-images.githubusercontent.com/35857179/127765860-968b0c64-f08d-4674-9ecc-4d5c5a00428b.png)
![image](https://user-images.githubusercontent.com/35857179/161957820-e0ac8b04-aafd-40c3-8fa8-2fdaa7dc157f.png)
You should see the similar result as below.

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

@ -14,9 +14,7 @@ menuTitle: 'Accessing APIs'
Auth Token is a JWT Token generated based on the logged-in user. By default, the token is only valid for 10 hours. However, you can change the value by defining it using environment variable NC_JWT_EXPIRES_IN. If you are passing Auth Token, make sure that the header is called xc-auth.
</alert>
<!-- TODO: update screenshot -->
![image](https://user-images.githubusercontent.com/35857179/126187328-745943f2-c780-4109-b967-1b3f1c4a1dcd.png)
![image](https://user-images.githubusercontent.com/35857179/161957971-e4888983-25e1-46a4-8419-7b9fae6cb6fa.png)
- Click the same button and click ``Swagger APIs Doc``.

19
packages/noco-docs/content/en/developer-resources/api-tokens.md
Unescape View File

@ -19,13 +19,18 @@ API Token is a Nano ID with a length of 40. If you are passing API Token, make s
### How to create a token ?
<!-- TODO: update screenshot -->
- ![1](https://user-images.githubusercontent.com/5435402/133734223-49bb1567-6cd2-43e5-bdda-aaccda741070.png)
- ![2](https://user-images.githubusercontent.com/5435402/133734234-5ca542b1-5843-46f7-b97b-9e686c6bf7ac.png)
- ![3](https://user-images.githubusercontent.com/5435402/133734238-33d5bdd0-5c97-4dbe-8e49-744193c3ac20.png)
- ![4](https://user-images.githubusercontent.com/5435402/133734239-7b530235-3352-497b-b23c-3a701290a569.png)
- ![5](https://user-images.githubusercontent.com/5435402/133734241-0f25bbd0-ab92-430a-9987-cc745d5b1b47.png)
- ![6](https://user-images.githubusercontent.com/5435402/133734243-6dc8527e-573d-45e2-8cd8-13a8beea0dfa.png)
1. Go to `Team & Settings` from the left navigation drawer
![image](https://user-images.githubusercontent.com/35857179/161902474-fd06678c-a171-4237-b171-dc028b3753de.png)
2. Click `API Tokens Management`
![image](https://user-images.githubusercontent.com/35857179/161958345-83cb60bf-80f1-4d11-9e9c-52d0b05c7677.png)
3. Click Add New Token
![image](https://user-images.githubusercontent.com/35857179/161958563-dc5d380a-26c5-4b78-9d4b-e40188bef05a.png)
4. Type an recognizable name for your token and click `Generate`
![image](https://user-images.githubusercontent.com/35857179/161958676-e4faa321-13ca-4b11-8d22-1332c522dde7.png)
5. Copy API token to your clipboard
![image](https://user-images.githubusercontent.com/35857179/161958822-b0689a6a-a864-429f-8bb2-71eb92808339.png)

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

@ -6,12 +6,10 @@ category: 'Product'
menuTitle: 'Audit'
---
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`.
We are keeping all the user operation logs under Audit. Audits logs can be accessed by clicking `Team & Settings` from the left navigation drawer.
<!-- TODO: update screenshot -->
![image](https://user-images.githubusercontent.com/35857179/161902474-fd06678c-a171-4237-b171-dc028b3753de.png)
![Screenshot_2021-07-23_at_7_08_22_PM](https://user-images.githubusercontent.com/61551451/126790439-14f4f60e-f125-48f8-a8a5-28f20fab71aa.png)
Then, under SETTINGS, click `Audit`.
<!-- TODO: update screenshot -->
![Pasted_Image_23_07_21__7_13_PM](https://user-images.githubusercontent.com/61551451/126790664-024f4803-c343-46ca-9b47-c3dfa0b1ad6c.png)
![image](https://user-images.githubusercontent.com/35857179/161956444-d1a28568-2adb-4e4e-9aca-4032b4a2f7c2.png)

4
packages/noco-docs/content/en/setup-and-usages/share-base.md
Unescape View File

@ -11,9 +11,7 @@ menuTitle: "Share Base"
- Open Project
- Click on `Share` button on top right tool bar
<!-- TODO: update screenshot -->
![Screenshot 2022-02-19 at 11 11 39 AM](https://user-images.githubusercontent.com/86527202/154789342-11546764-11ac-4ad1-a830-84cb603156b7.png)
![image](https://user-images.githubusercontent.com/35857179/161957411-ee9ec53d-4745-43c3-99f2-600cb20923e7.png)
- Under `Shared base link` tab and toggle from `Disabled Share base` to `Anyone with the link`

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

@ -14,23 +14,23 @@ Below are the steps to sync schema changes.
### 1. From the menu bar, click `Team & Settings`
<!-- TODO: add screenshot -->
![image](https://user-images.githubusercontent.com/35857179/161902474-fd06678c-a171-4237-b171-dc028b3753de.png)
### 2. Click `Project Metadata` under SETTINGS
<!-- TODO: add screenshot -->
![image](https://user-images.githubusercontent.com/35857179/161905030-6c5deef7-3a3d-4e71-8763-88e57586e5b4.png)
### 3. Under `Metadata` tab, click on `Metadata` sub tab
<!-- TODO: add screenshot -->
![image](https://user-images.githubusercontent.com/35857179/161956928-95d3646c-5ae4-4562-8a65-5e36a63e3c2a.png)
### 4. Changes carried outside GUI, identified by NocoDB are listed under `Sync state`
<!-- TODO: add screenshot -->
![image](https://user-images.githubusercontent.com/35857179/161957119-f66f22ad-9d37-45ed-84ca-35c99726078c.png)
### 5. Click `Sync Now` to complete Schema sync procedure
<!-- TODO: add screenshot -->
![image](https://user-images.githubusercontent.com/35857179/161957228-de6b0a50-0a0f-4d3d-8624-585a28851ad7.png)
#### Notes

Write Preview
Loading…
Cancel
Save