Merge pull request #1306 from nocodb/chore/documentation

docs: share base details
3 years ago · 9112a27ff8
1 changed files with 93 additions and 0 deletions
--- a/packages/noco-docs/content/en/developer-resources/share-base.md
+++ b/packages/noco-docs/content/en/developer-resources/share-base.md
@ -0,0 +1,93 @@
+---
+title: "Shared base"
+description: "Procedure for working with shared base & generating embedded IFRAMEs"
+position: 1050
+category: "Developer Resources"
+menuTitle: "Share Base"
+---
+
+## Generate 'Share base'
+
+-   Open Project base
+-   Click on 'Share' button on top right tool bar
+
+![Screenshot 2022-02-19 at 11 11 39 AM](https://user-images.githubusercontent.com/86527202/154789342-11546764-11ac-4ad1-a830-84cb603156b7.png)
+
+-   Under 'Shared base link' tab
+    -   Toggle from 'Disabled Share base' to 'Anyone with the link'
+
+![Screenshot 2022-02-19 at 11 16 02 AM](https://user-images.githubusercontent.com/86527202/154789352-87e65fcc-fbe5-48f0-a1e1-e54dce91a1f3.png)
+
+-   Share base link generated is displayed over & can be used to share this project to others in the team [Selection (2) in the image below]
+
+![Screenshot 2022-02-19 at 12 01 58 PM](https://user-images.githubusercontent.com/86527202/154789725-a1194e30-3101-423a-bd5c-25009c361b96.png)
+
+## Modify 'Share base'
+
+Modify 'Share base' will invalidate earlier generated 'Share base' link & generate a new link.
+
+-   Open Project base
+-   Click on 'Share' button on top right tool bar
+-   Under 'Shared base link' tab
+    -   Click on 'Reload' button
+
+## Disable 'Share base'
+
+Disable 'Share base' will invalidate generated 'Share base' link
+
+-   Open Project base
+-   Click on 'Share' button on top right tool bar
+-   Under 'Shared base link' tab
+    -   Toggle from 'Anyone with the link' to 'Disable Share base'
+
+## 'Share base' access permissions
+
+Shared base can be configured as
+
+-   Viewer: User with the link will get READ ONLY access to the project data
+-   Editor: User with the link will get READ WRITE access to the project data
+
+## Embeddable Frame
+
+NocoDB interface can be embedded into existing applications easily by making use of [HTML IFRAME](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe)) attribute.
+
+### Generate embeddable HTML code
+
+-   Open Project base
+-   Click on 'Share' button on top right tool bar
+-   Under 'Shared base link' tab
+    -   Click on </> button to copy 'Embeddable HTML code'
+
+Sample
+
+```html
+<iframe
+    class="nc-embed"
+    src="https://nocodb-nocodb-rsyir.ondigitalocean.app/dashboard/#/nc/base/e3bba9df-4fc1-4d11-b7ce-41c4a3ad6810?embed"
+    frameborder="0"
+    width="100%"
+    height="700"
+>
+    style="background: transparent; border: 1px solid #ddd"></iframe
+>
+```
+
+### Embed into application's HTML Body
+
+Sample code with embedded iframe generated above
+
+```html
+<!DOCTYPE html>
+<html>
+    <body>
+        <iframe
+            class="nc-embed"
+            src="http://localhost:3000/#/nc/base/7d4b551c-b5e0-41c9-a87b-f3984c21d2c7?embed"
+            frameborder="0"
+            width="100%"
+            height="700"
+            style="background: transparent; "
+        ></iframe>
+    </body>
+</html>
+```