Browse Source

docs: shared view

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
pull/6467/head
Raju Udava 1 year ago
parent
commit
fa0e345496
  1. 20
      packages/noco-docs/docs/090.views/025.share-view.md
  2. 21
      packages/noco-docs/docs/120.collaboration/040.share-view.md
  3. 6
      packages/noco-docs/docs/130.automation/020.webhook/040.actions-on-webhook.md
  4. BIN
      packages/noco-docs/static/img/v2-unannotated/views/share-button.png
  5. BIN
      packages/noco-docs/static/img/v2-unannotated/views/share-view-1.png
  6. BIN
      packages/noco-docs/static/img/v2-unannotated/views/share-view-form.png
  7. BIN
      packages/noco-docs/static/img/v2-unannotated/views/share-view-password.png
  8. BIN
      packages/noco-docs/static/img/v2-unannotated/views/share-view.png
  9. BIN
      packages/noco-docs/static/img/v2-unannotated/webhook/webhook-list.png
  10. BIN
      packages/noco-docs/static/img/v2/views/share-view/share-button.png
  11. BIN
      packages/noco-docs/static/img/v2/views/share-view/share-view-form.png
  12. BIN
      packages/noco-docs/static/img/v2/views/share-view/share-view-modal-2.png
  13. BIN
      packages/noco-docs/static/img/v2/views/share-view/share-view-modal-3.png
  14. BIN
      packages/noco-docs/static/img/v2/views/share-view/share-view-modal.png
  15. BIN
      packages/noco-docs/static/img/v2/views/share-view/share-view-password.png
  16. BIN
      packages/noco-docs/static/img/v2/views/share-view/share-view.png
  17. BIN
      packages/noco-docs/static/img/v2/webhook/webhook-list-2.png
  18. BIN
      packages/noco-docs/static/img/v2/webhook/webhook-list-3.png

20
packages/noco-docs/docs/090.views/025.share-view.md

@ -9,27 +9,23 @@ Sharing a specific view of a table becomes highly valuable when you need to coll
## Generate Share View ## Generate Share View
1. Click `Share` button on the top right of the toolbar 1. Click `Share` button on the top right of the toolbar
![share button](/img/v2/views/share-button.png)
2. Toggle `Enable public viewing` to create shared view link 2. Toggle `Enable public viewing` to create shared view link
![shared view](/img/v2/views/share-view-1.png)
3. Click `Copy` button to copy the link to clipboard 3. Click `Copy` button to copy the link to clipboard
![copy link](/img/v2/views/share-view-copy-link.png) ![share button](/img/v2/views/share-view/share-button.png)
![shared view](/img/v2/views/share-view/share-view-modal.png)
### Share view options ### Share view options
#### Password protection #### Password protection
You can enable `Restrict access with a password` if you want a password-protected view You can enable `Restrict access with a password` if you want a password-protected view
![password protection](/img/v2/views/share-view-password.png) ![password protection](/img/v2/views/share-view/share-view-modal-2.png)
#### Download options #### Download options
You can toggle `Allow Download` button to enable or disable download CSV/XLSX options in the shared view link You can toggle `Allow Download` button to enable or disable download CSV/XLSX options in the shared view link
![download options](/img/v2/views/share-view-download.png) ![download options](/img/v2/views/share-view/share-view-modal-3.png)
### Share Form View Options ### Share Form View Options
@ -37,19 +33,19 @@ Form view has additional customizations for shared view. You can enable/disable
1. `Survey mode`: This option when enabled, will display the form in survey mode. 1. `Survey mode`: This option when enabled, will display the form in survey mode.
2. `RTL Orientation`: This option when enabled, will display the form in RTL orientation. 2. `RTL Orientation`: This option when enabled, will display the form in RTL orientation.
3. `Themes`: You can select a theme for the form from the dropdown. 3. `Themes`: You can select a theme for the form from the dropdown.
![form view options](/img/v2/views/form-specific-configurations.png) ![form view options](/img/v2/views/share-view/share-view-form.png)
## Access Share View ## Access Share View
To access the shared view, please follow the steps below: To access the shared view, please follow the steps below:
Click on the `Shared View URL`. If the URL is password-protected, you will be prompted to enter the password to unlock it. Please input the required password to proceed. Click on the `Shared View URL`. If the URL is password-protected, you will be prompted to enter the password to unlock it. Please input the required password to proceed.
![image](https://user-images.githubusercontent.com/35857179/194690379-e3d89df6-d9c1-4d9d-9e8c-7e59c3978d31.png) ![password modal](/img/v2/views/share-view/share-view-password.png)
Once the password is successfully entered and authenticated, you will gain access to the shared view. Once the password is successfully entered and authenticated, you will gain access to the shared view.
In the event that the URL is not password-protected, you will be directed to the shared view directly, without the need for a password. In the event that the URL is not password-protected, you will be directed to the shared view directly, without the need for a password.
![image](https://user-images.githubusercontent.com/35857179/194690389-5b78e236-aacc-49c2-898e-110f95edd1e5.png) ![share-view](/img/v2/views/share-view/share-view.png)
Users with the shared view link can only view the data and cannot make any changes to the view or its content. Records and fields in the shared view will be updated in real-time as changes are made to the original view. Users accessing shared view can apply filters and sort records as per their requirements. Users with the shared view link can only view the data and cannot make any changes to the view or its content. Records and fields in the shared view will be updated in real-time as changes are made to the original view. Users accessing shared view can apply filters and sort records as per their requirements.

21
packages/noco-docs/docs/120.collaboration/040.share-view.md

@ -5,30 +5,25 @@ tags: ["Views", "Share", "Grid View", "Form View", "Kanban View", "Gallery View"
keywords: ["NocoDB view", "share view", "share", "share view with password protection", "share view with download options"] keywords: ["NocoDB view", "share view", "share", "share view with password protection", "share view with download options"]
--- ---
## Generate Share View ## Generate Share View
1. Click `Share` button on the top right of the toolbar 1. Click `Share` button on the top right of the toolbar
![share button](/img/v2/views/share-button.png)
2. Toggle `Enable public viewing` to create shared view link 2. Toggle `Enable public viewing` to create shared view link
![shared view](/img/v2/views/share-view-1.png)
3. Click `Copy` button to copy the link to clipboard 3. Click `Copy` button to copy the link to clipboard
![copy link](/img/v2/views/share-view-copy-link.png) ![share button](/img/v2/views/share-view/share-button.png)
![shared view](/img/v2/views/share-view/share-view-modal.png)
### Share view options ### Share view options
#### Password protection #### Password protection
You can enable `Restrict access with a password` if you want a password-protected view You can enable `Restrict access with a password` if you want a password-protected view
![password protection](/img/v2/views/share-view-password.png) ![password protection](/img/v2/views/share-view/share-view-modal-2.png)
#### Download options #### Download options
You can toggle `Allow Download` button to enable or disable download CSV/XLSX options in the shared view link You can toggle `Allow Download` button to enable or disable download CSV/XLSX options in the shared view link
![download options](/img/v2/views/share-view-download.png) ![download options](/img/v2/views/share-view/share-view-modal-3.png)
### Share Form View Options ### Share Form View Options
@ -36,19 +31,19 @@ Form view has additional customizations for shared view. You can enable/disable
1. `Survey mode`: This option when enabled, will display the form in survey mode. 1. `Survey mode`: This option when enabled, will display the form in survey mode.
2. `RTL Orientation`: This option when enabled, will display the form in RTL orientation. 2. `RTL Orientation`: This option when enabled, will display the form in RTL orientation.
3. `Themes`: You can select a theme for the form from the dropdown. 3. `Themes`: You can select a theme for the form from the dropdown.
![form view options](/img/v2/views/form-specific-configurations.png) ![form view options](/img/v2/views/share-view/share-view-form.png)
## Access Share View ## Access Share View
To access the shared view, please follow the steps below: To access the shared view, please follow the steps below:
Click on the `Shared View URL`. If the URL is password-protected, you will be prompted to enter the password to unlock it. Please input the required password to proceed. Click on the `Shared View URL`. If the URL is password-protected, you will be prompted to enter the password to unlock it. Please input the required password to proceed.
![image](https://user-images.githubusercontent.com/35857179/194690379-e3d89df6-d9c1-4d9d-9e8c-7e59c3978d31.png) ![password modal](/img/v2/views/share-view/share-view-password.png)
Once the password is successfully entered and authenticated, you will gain access to the shared view. Once the password is successfully entered and authenticated, you will gain access to the shared view.
In the event that the URL is not password-protected, you will be directed to the shared view directly, without the need for a password. In the event that the URL is not password-protected, you will be directed to the shared view directly, without the need for a password.
![image](https://user-images.githubusercontent.com/35857179/194690389-5b78e236-aacc-49c2-898e-110f95edd1e5.png) ![share-view](/img/v2/views/share-view/share-view.png)
Users with the shared view link can only view the data and cannot make any changes to the view or its content. Records and fields in the shared view will be updated in real-time as changes are made to the original view. Users accessing shared view can apply filters and sort records as per their requirements. Users with the shared view link can only view the data and cannot make any changes to the view or its content. Records and fields in the shared view will be updated in real-time as changes are made to the original view. Users accessing shared view can apply filters and sort records as per their requirements.

6
packages/noco-docs/docs/130.automation/020.webhook/040.actions-on-webhook.md

@ -9,7 +9,7 @@ To disable a Webhook
- Open `Webhook` tab to find list of webhooks created - Open `Webhook` tab to find list of webhooks created
- Toggle `Activate` button to enable/disable - Toggle `Activate` button to enable/disable
![Screenshot 2023-09-01 at 3 59 28 PM](https://github.com/nocodb/nocodb/assets/86527202/c62cca12-6164-46a8-87e5-179d28c989b6) ![Webhook List](/img/v2/webhook/webhook-list-2.png)
### Delete Webhook ### Delete Webhook
@ -19,7 +19,7 @@ To delete a Webhook
- Click on `...` actions button associated with the webhook to be deleted - Click on `...` actions button associated with the webhook to be deleted
- Select `Delete` - Select `Delete`
![Screenshot 2023-09-01 at 4 01 46 PM](https://github.com/nocodb/nocodb/assets/86527202/23a8aec1-ba29-4be4-8143-f3c94198a88c) ![Webhook context menu](/img/v2/webhook/webhook-list-3.png)
### Duplicate Webhook ### Duplicate Webhook
@ -29,7 +29,7 @@ To duplicate a Webhook
- Click on `...` actions button associated with the webhook to be duplicate - Click on `...` actions button associated with the webhook to be duplicate
- Select `Duplicate` - Select `Duplicate`
![Screenshot 2023-09-01 at 4 01 46 PM](https://github.com/nocodb/nocodb/assets/86527202/23a8aec1-ba29-4be4-8143-f3c94198a88c) ![Webhook context menu](/img/v2/webhook/webhook-list-3.png)
A copy of the webhook will be created (disabled by default) with a suffix ` - Copy` A copy of the webhook will be created (disabled by default) with a suffix ` - Copy`

BIN
packages/noco-docs/static/img/v2-unannotated/views/share-button.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 273 KiB

BIN
packages/noco-docs/static/img/v2-unannotated/views/share-view-1.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 540 KiB

BIN
packages/noco-docs/static/img/v2-unannotated/views/share-view-form.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 497 KiB

BIN
packages/noco-docs/static/img/v2-unannotated/views/share-view-password.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

BIN
packages/noco-docs/static/img/v2-unannotated/views/share-view.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 420 KiB

BIN
packages/noco-docs/static/img/v2-unannotated/webhook/webhook-list.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 152 KiB

BIN
packages/noco-docs/static/img/v2/views/share-view/share-button.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 211 KiB

BIN
packages/noco-docs/static/img/v2/views/share-view/share-view-form.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 356 KiB

BIN
packages/noco-docs/static/img/v2/views/share-view/share-view-modal-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 400 KiB

BIN
packages/noco-docs/static/img/v2/views/share-view/share-view-modal-3.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 400 KiB

BIN
packages/noco-docs/static/img/v2/views/share-view/share-view-modal.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 405 KiB

BIN
packages/noco-docs/static/img/v2/views/share-view/share-view-password.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

BIN
packages/noco-docs/static/img/v2/views/share-view/share-view.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 420 KiB

BIN
packages/noco-docs/static/img/v2/webhook/webhook-list-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 123 KiB

BIN
packages/noco-docs/static/img/v2/webhook/webhook-list-3.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 128 KiB

Loading…
Cancel
Save