Browse Source

docs: update screenshots

pull/3976/head
Wing-Kam Wong 2 years ago
parent
commit
371dcdac6c
  1. 14
      packages/noco-docs/content/en/developer-resources/accessing-apis.md
  2. 2
      packages/noco-docs/content/en/setup-and-usages/audit.md
  3. 2
      packages/noco-docs/content/en/setup-and-usages/meta-management.md
  4. 5
      packages/noco-docs/content/en/setup-and-usages/rollup.md
  5. 2
      packages/noco-docs/content/en/setup-and-usages/sync-schema.md
  6. 2
      packages/noco-docs/content/en/setup-and-usages/team-and-auth.md

14
packages/noco-docs/content/en/developer-resources/accessing-apis.md

@ -14,34 +14,27 @@ Auth Token is a JWT Token generated based on the logged-in user. By default, the
- Go to NocoDB Project, click the rightmost button and click ``Copy Auth Token``.
![Screenshot 2022-09-14 at 10 18 58 AM](https://user-images.githubusercontent.com/86527202/190062565-34ec5f49-b2a9-4ccb-a02f-8ea60980ffd9.png)
<!-- <img width="219" alt="image" src="https://user-images.githubusercontent.com/35857179/164874424-7622112f-9729-4514-81d2-5c6631b19ed0.png"> -->
<img width="357" alt="image" src="https://user-images.githubusercontent.com/35857179/194856397-b2e194e8-5ca1-420e-8b46-e1345d1d91d3.png">
## 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`.
- Open `Project Menu`, click on `Team & Settings`
<img width="324" alt="image" src="https://user-images.githubusercontent.com/35857179/194796383-2690375a-52eb-4419-b9cf-288cca88e786.png">
<!-- ![image](https://user-images.githubusercontent.com/35857179/161902474-fd06678c-a171-4237-b171-dc028b3753de.png) -->
<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
<!-- ![image](https://user-images.githubusercontent.com/35857179/161958345-83cb60bf-80f1-4d11-9e9c-52d0b05c7677.png) -->
- 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)
<!-- ![image](https://user-images.githubusercontent.com/35857179/161958563-dc5d380a-26c5-4b78-9d4b-e40188bef05a.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)
<!-- ![image](https://user-images.githubusercontent.com/35857179/161958676-e4faa321-13ca-4b11-8d22-1332c522dde7.png) -->
- Copy API token to your clipboard; use action menu to the right of token list
<!-- ![image](https://user-images.githubusercontent.com/35857179/161958822-b0689a6a-a864-429f-8bb2-71eb92808339.png) -->
## Swagger UI
@ -49,8 +42,7 @@ You can interact with the API's resources via Swagger UI.
- Go to NocoDB Project, click the rightmost button and click ``Swagger APIs Doc``.
![Screenshot 2022-09-14 at 10 22 00 AM](https://user-images.githubusercontent.com/86527202/190062896-c1c2d529-694f-46ad-b6b1-0ee8d71a6e14.png)
<!-- <img width="215" alt="image" src="https://user-images.githubusercontent.com/35857179/164874429-d8e8f129-9cca-4d47-92c4-0b34b6e0b922.png"> -->
<img width="325" alt="image" src="https://user-images.githubusercontent.com/35857179/194856535-c81bfc2a-8cdd-41aa-8aa6-9c667c972fa4.png">
- Click ``Authorize``, paste the token you copied in above steps and click `Authorize` to save.

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

@ -8,7 +8,7 @@ menuTitle: 'Audit'
We are keeping all the user operation logs under Audit. To access it, click the down arrow button next to Project Name on the top left side, then select `Team & Settings`.
<img width="324" alt="image" src="https://user-images.githubusercontent.com/35857179/194796383-2690375a-52eb-4419-b9cf-288cca88e786.png">
<img width="322" alt="image" src="https://user-images.githubusercontent.com/35857179/194856648-67936db0-ee4d-4060-be3d-af9f86ef8fc6.png">
Then, under SETTINGS, click `Audit`.

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

@ -10,7 +10,7 @@ Project Metadata includes Database Metadata, UI Access Control and Miscellaneous
To access it, click the down arrow button next to Project Name on the top left side, then select `Team & Settings` and clicking `Project Metadata`.
<img width="324" alt="image" src="https://user-images.githubusercontent.com/35857179/194796383-2690375a-52eb-4419-b9cf-288cca88e786.png"> | <img width="471" alt="image" src="https://user-images.githubusercontent.com/35857179/194850848-869c69a4-e9b6-4a84-8cc0-7fd4b01eb1ad.png">
<img width="322" alt="image" src="https://user-images.githubusercontent.com/35857179/194856648-67936db0-ee4d-4060-be3d-af9f86ef8fc6.png"> | <img width="471" alt="image" src="https://user-images.githubusercontent.com/35857179/194850848-869c69a4-e9b6-4a84-8cc0-7fd4b01eb1ad.png">
|--|--|
<!-- ## Project Metadata

5
packages/noco-docs/content/en/setup-and-usages/rollup.md

@ -74,7 +74,4 @@ Aggregate function will be "count" in our case
Column `Employee Count` is populated with appropriate information
![Screenshot 2022-09-09 at 1 07 45 PM](https://user-images.githubusercontent.com/86527202/189297662-c7ff1e3e-eec7-4108-a089-6c945b90b867.png)
<!-- ![8](https://user-images.githubusercontent.com/86527202/144236291-52855f92-ad8b-4be1-aa98-b5cfdb1ee108.png) -->
![image](https://user-images.githubusercontent.com/35857179/194856842-e35a6424-fb95-4805-8efa-a559563e4b71.png)

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

@ -14,7 +14,7 @@ Below are the steps to sync schema changes.
### 1. From the `Project menu`, click `Team & Settings`
<img width="324" alt="image" src="https://user-images.githubusercontent.com/35857179/194796383-2690375a-52eb-4419-b9cf-288cca88e786.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
packages/noco-docs/content/en/setup-and-usages/team-and-auth.md

@ -10,7 +10,7 @@ menuTitle: 'Team & Auth'
- Click on `Team & Settings` from the `Project Menu`
- Access `Team & Auth` under `Settings`
<img width="324" alt="image" src="https://user-images.githubusercontent.com/35857179/194796383-2690375a-52eb-4419-b9cf-288cca88e786.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

Loading…
Cancel
Save