Browse Source

docs: links reconfigure

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
pull/6467/head
Raju Udava 1 year ago
parent
commit
74809232ef
  1. 70
      packages/noco-docs/docs/010.index.md
  2. 73
      packages/noco-docs/docs/020.getting-started/010.introduction-to-nocodb.md
  3. 25
      packages/noco-docs/docs/020.getting-started/030.terminologies.md
  4. 10
      packages/noco-docs/docs/030.workspaces/010.workspace-overview.md
  5. 8
      packages/noco-docs/docs/030.workspaces/020.create-workspace.md
  6. 9
      packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md
  7. 6
      packages/noco-docs/docs/030.workspaces/040.delete-workspace.md
  8. 6
      packages/noco-docs/docs/030.workspaces/050.actions-on-workspace.md
  9. 8
      packages/noco-docs/docs/040.bases/010.base-overview.md
  10. 10
      packages/noco-docs/docs/040.bases/020.create-base.md
  11. 11
      packages/noco-docs/docs/040.bases/060.create-base-using-template.md
  12. 10
      packages/noco-docs/docs/040.bases/070.import-base-from-airtable.md
  13. 11
      packages/noco-docs/docs/040.bases/075.base-collaboration.md
  14. 9
      packages/noco-docs/docs/040.bases/076.share-base.md
  15. 9
      packages/noco-docs/docs/040.bases/080.delete-base.md
  16. 9
      packages/noco-docs/docs/040.bases/090.actions-on-base.md

70
packages/noco-docs/docs/010.index.md

@ -4,4 +4,74 @@ description: 'NocoDB Documentation'
slug: /
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
![image](/img/banner.png)
NocoDB is a no-code database platform that allows teams to collaborate and build applications with ease of a familiar and intuitive spreadsheet interface. This allows even non-developers or business users to become software creators.
NocoDB works by connecting to any relational database and transforming them into a smart spreadsheet interface! This allows you to build no-code applications collaboratively with teams. NocoDB currently works with MySQL, PostgreSQL, Microsoft SQL Server, SQLite, Amazon Aurora & MariaDB databases.
Also NocoDB's app store allows you to build business workflows on views with combination of Slack, Microsoft Teams, Discord, Twilio, Whatsapp, Email & any 3rd party APIs too. Plus NocoDB provides programmatic access to APIs so that you can build integrations with Zapier / Integromat and custom applications too.
## Features
### Rich Spreadsheet Interface
- ⚡ &nbsp;Basic Operations: Create, Read, Update and Delete on Tables, Columns, and Rows
- ⚡ &nbsp;Fields Operations: Sort, Filter, Hide / Unhide Columns
- ⚡ &nbsp;Multiple Views Types: Grid (By default), Gallery, Form View and Kanban View
- ⚡ &nbsp;View Permissions Types: Collaborative Views, & Locked Views
- ⚡ &nbsp;Share Bases / Views: either Public or Private (with Password Protected)
- ⚡ &nbsp;Variant Cell Types: ID, LinkToAnotherRecord, Lookup, Rollup, SingleLineText, Attachement, Currency, Formula and etc
- ⚡ &nbsp;Access Control with Roles : Fine-grained Access Control at different levels
- ⚡ &nbsp;and more ...
### App Store for Workflow Automations
We provide different integrations in three main categories. See <a href="/setup-and-usages/account-settings#app-store" target="_blank">App Store</a> for details.
- ⚡ &nbsp;Chat : Slack, Discord, Mattermost, and etc
- ⚡ &nbsp;Email : AWS SES, SMTP, MailerSend, and etc
- ⚡ &nbsp;Storage : AWS S3, Google Cloud Storage, Minio, and etc
### Programmatic Access
We provide the following ways to let users to invoke actions in a programmatic way. You can use a token (either JWT or Social Auth) to sign your requests for authorization to NocoDB.
- ⚡ &nbsp;REST APIs
- ⚡ &nbsp;NocoDB SDK
### Sync Schema
We allow 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. See <a href="/setup-and-usages/sync-schema" target="_blank">Sync Schema</a> for details.
### Audit
We are keeping all the user operation logs under one place. See <a href="/setup-and-usages/audit" target="_blank">Audit</a> for details.
## Why are we building this?
Most internet businesses equip themselves with either spreadsheet or a database to solve their business needs. Spreadsheets are used by a Billion+ humans collaboratively every single day. However, we are way off working at similar speeds on databases which are way more powerful tools when it comes to computing. Attempts to solve this with SaaS offerings has meant horrible access controls, vendor lockin, data lockin, abrupt price changes & most importantly a glass ceiling on what's possible in future.
## Our Mission
Our mission is to provide the most powerful no-code interface for databases which is open source to every single internet business in the world. This would not only democratise access to a powerful computing tool but also bring forth a billion+ people who will have radical tinkering-and-building abilities on internet.
## How can I contribute to NocoDB's development ?
Please refer to [here](https://github.com/nocodb/nocodb/blob/develop/.github/CONTRIBUTING.md) for the contribution guidelines.
<img src="https://static.scarf.sh/a.png?x-pxid=c12a77cc-855e-4602-8a0f-614b2d0da56a" style={{margin: '0px'}} />
## Where can I join the NocoDB community?
Follow us for daily updates, content, and other activities with our community:
- [Youtube](https://www.youtube.com/@nocodb)
- [Twitter](https://twitter.com/nocodb)
- [Discord](http://discord.nocodb.com/)
- [GitHub](https://github.com/nocodb/nocodb)
- [Community Forums](https://community.nocodb.com/)
- [LinkedIn](https://www.linkedin.com/company/nocodb)
- [Reddit](https://www.reddit.com/r/NocoDB/)

73
packages/noco-docs/docs/020.getting-started/010.introduction-to-nocodb.md

@ -1,73 +0,0 @@
---
title: 'Introduction to NocoDB'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
![image](/img/banner.png)
NocoDB is a no-code database platform that allows teams to collaborate and build applications with ease of a familiar and intuitive spreadsheet interface. This allows even non-developers or business users to become software creators.
NocoDB works by connecting to any relational database and transforming them into a smart spreadsheet interface! This allows you to build no-code applications collaboratively with teams. NocoDB currently works with MySQL, PostgreSQL, Microsoft SQL Server, SQLite, Amazon Aurora & MariaDB databases.
Also NocoDB's app store allows you to build business workflows on views with combination of Slack, Microsoft Teams, Discord, Twilio, Whatsapp, Email & any 3rd party APIs too. Plus NocoDB provides programmatic access to APIs so that you can build integrations with Zapier / Integromat and custom applications too.
## Features
### Rich Spreadsheet Interface
- ⚡ &nbsp;Basic Operations: Create, Read, Update and Delete on Tables, Columns, and Rows
- ⚡ &nbsp;Fields Operations: Sort, Filter, Hide / Unhide Columns
- ⚡ &nbsp;Multiple Views Types: Grid (By default), Gallery, Form View and Kanban View
- ⚡ &nbsp;View Permissions Types: Collaborative Views, & Locked Views
- ⚡ &nbsp;Share Bases / Views: either Public or Private (with Password Protected)
- ⚡ &nbsp;Variant Cell Types: ID, LinkToAnotherRecord, Lookup, Rollup, SingleLineText, Attachement, Currency, Formula and etc
- ⚡ &nbsp;Access Control with Roles : Fine-grained Access Control at different levels
- ⚡ &nbsp;and more ...
### App Store for Workflow Automations
We provide different integrations in three main categories. See <a href="/setup-and-usages/account-settings#app-store" target="_blank">App Store</a> for details.
- ⚡ &nbsp;Chat : Slack, Discord, Mattermost, and etc
- ⚡ &nbsp;Email : AWS SES, SMTP, MailerSend, and etc
- ⚡ &nbsp;Storage : AWS S3, Google Cloud Storage, Minio, and etc
### Programmatic Access
We provide the following ways to let users to invoke actions in a programmatic way. You can use a token (either JWT or Social Auth) to sign your requests for authorization to NocoDB.
- ⚡ &nbsp;REST APIs
- ⚡ &nbsp;NocoDB SDK
### Sync Schema
We allow 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. See <a href="/setup-and-usages/sync-schema" target="_blank">Sync Schema</a> for details.
### Audit
We are keeping all the user operation logs under one place. See <a href="/setup-and-usages/audit" target="_blank">Audit</a> for details.
## Why are we building this?
Most internet businesses equip themselves with either spreadsheet or a database to solve their business needs. Spreadsheets are used by a Billion+ humans collaboratively every single day. However, we are way off working at similar speeds on databases which are way more powerful tools when it comes to computing. Attempts to solve this with SaaS offerings has meant horrible access controls, vendor lockin, data lockin, abrupt price changes & most importantly a glass ceiling on what's possible in future.
## Our Mission
Our mission is to provide the most powerful no-code interface for databases which is open source to every single internet business in the world. This would not only democratise access to a powerful computing tool but also bring forth a billion+ people who will have radical tinkering-and-building abilities on internet.
## How can I contribute to NocoDB's development ?
Please refer to [here](https://github.com/nocodb/nocodb/blob/develop/.github/CONTRIBUTING.md) for the contribution guidelines.
<img src="https://static.scarf.sh/a.png?x-pxid=c12a77cc-855e-4602-8a0f-614b2d0da56a" style={{margin: '0px'}} />
## Where can I join the NocoDB community?
Follow us for daily updates, content, and other activities with our community:
- [Youtube](https://www.youtube.com/@nocodb)
- [Twitter](https://twitter.com/nocodb)
- [Discord](http://discord.nocodb.com/)
- [GitHub](https://github.com/nocodb/nocodb)
- [Community Forums](https://community.nocodb.com/)
- [LinkedIn](https://www.linkedin.com/company/nocodb)
- [Reddit](https://www.reddit.com/r/NocoDB/)

25
packages/noco-docs/docs/020.getting-started/030.terminologies.md

@ -22,15 +22,16 @@ Layout below shows broader components of NocoDB's UI.
## Terminologies
| Term | Description |
|--------------------------:|:--------------------------------------------------------------------------------------------------------------|
| Workspace | Collection of one or more bases |
| Base | Collection of one or more tables, often related and linked to one another |
| Table | |
| Field | |
| Record | |
| View | |
| Workspace Collaborator | Workspace member with specific access permissions |
| Workspace Owner | Member who had created workspace. There can be only one owner for a workspace & ownership is non-transferable |
| Base Collaborator | Base member with specific access permissions |
| Base Owner | Member who had created base. There can be only one owner for a base & ownership is non-transferable |
| Term | Description |
|-----------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Workspace | A workspace is a collection of one or more bases. It offers collaborative access to bases by enabling you to bring together interconnected tables, views, and various elements into a unified and organized entity |
| Base | A base is a collection of one or more tables, often related and linked to one another |
| Table | A base is housed in tables, where data is logically arranged into rows and columns. A base can have multiple tables |
| Field | A field or column in a table is a container for values that share the same data type. |
| Record | A record represents a row in a table. |
| View | A view defines how data within a table is presented and interacted with. Default view type is the grid view; other supported view types include form, gallery, and kanban views. |
| Cell | A cell represents the space created where a column and a row intersect within a grid-like structure. It serves as the fundamental unit for storing data |
| Workspace Collaborator | Workspace member with specific access permissions |
| Workspace Owner | Member who had created workspace. There can be only one owner for a workspace & ownership is non-transferable |
| Base Collaborator | Base member with specific access permissions |
| Base Owner | Member who had created base. There can be only one owner for a base & ownership is non-transferable |

10
packages/noco-docs/docs/030.workspaces/010.workspace-overview.md

@ -4,7 +4,7 @@ title: 'Workspace overview'
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Workspaces in NocoDB are collection of one or more bases. You can create multiple workspaces to organize your bases and collaborators. Some of the key points to note about workspaces are:
Workspaces in NocoDB are collection of one or more [Bases](/bases/base-overview). You can create multiple workspaces to organize your bases and collaborators. Some of the key points to note about workspaces are:
- Each workspace has its own set of bases.
- Each workspace has its own set of collaborators and access permissions.
- Each workspace has its own set of settings & billing plans
@ -25,4 +25,10 @@ Workspace context menu is accessible from the left sidebar.
### List workspaces
Workspace context menu lists all the workspaces you have access to. You can switch between workspaces by clicking on the workspace name.
![image](/img/v2/workspace-list.png)
![image](/img/v2/workspace-list.png)
## Related articles
- [Create workspace](/workspaces/create-workspace)
- [Delete workspace](/workspaces/delete-workspace)
- [Workspace collaboration](/workspaces/workspace-collaboration)
- [Workspace actions](/workspaces/actions-on-workspace)

8
packages/noco-docs/docs/030.workspaces/020.create-workspace.md

@ -30,4 +30,10 @@ Upon the creation of a new workspace, you are automatically designated as the wo
:::info
- You can create only one workspace in the self-hosted plan (default).
- On signup, a default workspace is created for you. You can rename it or create a new one.
:::
:::
## Related articles
- [Workspace overview](/workspaces/workspace-overview)
- [Delete workspace](/workspaces/delete-workspace)
- [Workspace collaboration](/workspaces/workspace-collaboration)
- [Workspace actions](/workspaces/actions-on-workspace)

9
packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md

@ -28,4 +28,11 @@ You can change the access permission of the collaborator by clicking on the acce
### Remove collaborator
You can also remove collaborators from the workspace by clicking on the vertical ellipses `⋮` to open the context menu and selecting `Remove User` option. Refer **<3>** below.
![image](/img/v2/workspace-collaboration-actions.png)
![image](/img/v2/workspace-collaboration-actions.png)
## Related articles
- [Workspace overview](/workspaces/workspace-overview)
- [Create workspace](/workspaces/create-workspace)
- [Delete workspace](/workspaces/delete-workspace)
- [Workspace actions](/workspaces/actions-on-workspace)

6
packages/noco-docs/docs/030.workspaces/040.delete-workspace.md

@ -25,3 +25,9 @@ To delete a workspace:
![image](/img/v2/workspace-delete.png)
![image](/img/v2/workspace-delete-confirmation.png)
## Related articles
- [Workspace overview](/workspaces/workspace-overview)
- [Create workspace](/workspaces/create-workspace)
- [Workspace collaboration](/workspaces/workspace-collaboration)
- [Workspace actions](/workspaces/actions-on-workspace)

6
packages/noco-docs/docs/030.workspaces/050.actions-on-workspace.md

@ -13,3 +13,9 @@ To change workspace name:
4. Click on `Rename Workspace` button.
![image](/img/v2/workspace-rename.png)
## Related articles
- [Workspace overview](/workspaces/workspace-overview)
- [Create workspace](/workspaces/create-workspace)
- [Delete workspace](/workspaces/delete-workspace)
- [Workspace collaboration](/workspaces/workspace-collaboration)

8
packages/noco-docs/docs/040.bases/010.base-overview.md

@ -27,3 +27,11 @@ List of collaborators in the base along with their current permission levels. Wo
### Data Sources
NocoDB allows you to connect to external data sources & work with them as if they are native tables. List of connected data sources are listed here. Additional details will be dealt with in section [Data Sources](/docs/050.data-sources/010.data-sources-overview.md).
## Related articles
- [Create base](/bases/create-base)
- [Create base using template](/bases/create-base-using-template)
- [Import base from Airtable](/bases/import-base-from-airtable)
- [Base collaboration](/bases/base-collaboration)
- [Share base](/bases/share-base)
- [Base actions](/bases/actions-on-base)
- [Delete base](/bases/delete-base)

10
packages/noco-docs/docs/040.bases/020.create-base.md

@ -17,4 +17,12 @@ import TabItem from '@theme/TabItem';
- You will be marked as `base owner` on creation of the base.
- Only `base owner` has the authority to delete a base.
- You can create multiple bases within a workspace.
:::
:::
## Related articles
- [Base overview](/bases/base-overview)
- [Create base using template](/bases/create-base-using-template)
- [Import base from Airtable](/bases/import-base-from-airtable)
- [Base collaboration](/bases/base-collaboration)
- [Share base](/bases/share-base)
- [Base actions](/bases/actions-on-base)
- [Delete base](/bases/delete-base)

11
packages/noco-docs/docs/040.bases/060.create-base-using-template.md

@ -2,4 +2,13 @@
title: 'Create base using template'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import TabItem from '@theme/TabItem';
## Related articles
- [Base overview](/bases/base-overview)
- [Create base](/bases/create-base)
- [Import base from Airtable](/bases/import-base-from-airtable)
- [Base collaboration](/bases/base-collaboration)
- [Share base](/bases/share-base)
- [Base actions](/bases/actions-on-base)
- [Delete base](/bases/delete-base)

10
packages/noco-docs/docs/040.bases/070.import-base-from-airtable.md

@ -75,3 +75,13 @@ See [here](https://support.airtable.com/hc/en-us/articles/205752117-Creating-a-b
![Screenshot 2022-05-16 at 3 41 54 PM](https://user-images.githubusercontent.com/86527202/168572062-5dee065d-2394-426d-8f43-77ecc0c9b73f.png)
## Related articles
- [Base overview](/bases/base-overview)
- [Create base](/bases/create-base)
- [Create base using template](/bases/create-base-using-template)
- [Base collaboration](/bases/base-collaboration)
- [Share base](/bases/share-base)
- [Base actions](/bases/actions-on-base)
- [Delete base](/bases/delete-base)

11
packages/noco-docs/docs/040.bases/075.base-collaboration.md

@ -15,4 +15,13 @@ Invite collaborators to your base by following simple steps below:
:::info
You can invite multiple collaborators at once by entering multiple email addresses separated by comma.
:::
:::
## Related articles
- [Base overview](/bases/base-overview)
- [Create base](/bases/create-base)
- [Create base using template](/bases/create-base-using-template)
- [Import base from Airtable](/bases/import-base-from-airtable)
- [Share base](/bases/share-base)
- [Base actions](/bases/actions-on-base)
- [Delete base](/bases/delete-base)

9
packages/noco-docs/docs/040.bases/076.share-base.md

@ -90,3 +90,12 @@ Sample code with embedded iframe generated above
</body>
</html>
```
## Related articles
- [Base overview](/bases/base-overview)
- [Create base](/bases/create-base)
- [Create base using template](/bases/create-base-using-template)
- [Import base from Airtable](/bases/import-base-from-airtable)
- [Base collaboration](/bases/base-collaboration)
- [Base actions](/bases/actions-on-base)
- [Delete base](/bases/delete-base)

9
packages/noco-docs/docs/040.bases/080.delete-base.md

@ -23,3 +23,12 @@ To delete a base:
![image](/img/v2/base-delete.png)
![image](/img/v2/base-delete-confirmation.png)
## Related articles
- [Base overview](/bases/base-overview)
- [Create base](/bases/create-base)
- [Create base using template](/bases/create-base-using-template)
- [Import base from Airtable](/bases/import-base-from-airtable)
- [Base collaboration](/bases/base-collaboration)
- [Share base](/bases/share-base)
- [Base actions](/bases/actions-on-base)

9
packages/noco-docs/docs/040.bases/090.actions-on-base.md

@ -59,3 +59,12 @@ You can duplicate a base by following simple steps below:
- You will be marked as `base owner` on duplication of the base.
- Existing base collaborators are not migrated to the duplicated base.
:::
## Related articles
- [Base overview](/bases/base-overview)
- [Create base](/bases/create-base)
- [Create base using template](/bases/create-base-using-template)
- [Import base from Airtable](/bases/import-base-from-airtable)
- [Base collaboration](/bases/base-collaboration)
- [Share base](/bases/share-base)
- [Delete base](/bases/delete-base)
Loading…
Cancel
Save