Browse Source

docs: workspace briefing

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
pull/6467/head
Raju Udava 1 year ago
parent
commit
cc2b92ce8b
  1. 1
      packages/noco-docs/docs/010.index.md
  2. 18
      packages/noco-docs/docs/020.getting-started/030.terminologies.md
  3. 39
      packages/noco-docs/docs/020.getting-started/040.keyboard-shortcuts.md
  4. 19
      packages/noco-docs/docs/030.workspaces/010.workspace-overview.md
  5. BIN
      packages/noco-docs/static/img/v2-unannotated/cmd-j.png
  6. BIN
      packages/noco-docs/static/img/v2-unannotated/cmd-k.png
  7. BIN
      packages/noco-docs/static/img/v2-unannotated/cmd-l.png
  8. BIN
      packages/noco-docs/static/img/v2/cmd-j.png
  9. BIN
      packages/noco-docs/static/img/v2/cmd-k.png
  10. BIN
      packages/noco-docs/static/img/v2/cmd-l.png

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

@ -39,6 +39,7 @@ We provide the following ways to let users invoke actions in a programmatic way.
- ⚡ &nbsp;REST APIs
- ⚡ &nbsp;NocoDB SDK
- ⚡ &nbsp;SQL Access : Run SQL queries on your data source from NocoDB UI itself (Coming soon!)
### Sync Schema

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

@ -30,15 +30,17 @@ The layout below shows the main parts of NocoDB's user interface.
| 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. Alternative term `Project` |
| Table | A base is housed in tables, where data is logically arranged into rows and columns. A base can have multiple tables. Alternative term `Model` |
| Field | A field or column in a table is a container for values that share the same data type. Alternative term `Column` |
| Base Owner | Member who had created base. There can be only one owner for a base & ownership is non-transferable |
| Base member | Base member with specific access permissions. Alternative term `Member` `User` |
| 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 |
| Field | A field or column in a table is a container for values that share the same data type. Alternative term `Column` |
| Modal | In the context of user interfaces, a modal is a type of dialog or overlay that appears on top of the main content or interface and requires user interaction before the user can proceed. Modals are often used to gather user input, display alerts, or confirm actions. They typically "block" the rest of the interface until the user dismisses them, making them a focused and attention-grabbing element |
| Record | A record represents a row in a table. Alternative term `Row` |
| Table | A base is housed in tables, where data is logically arranged into rows and columns. A base can have multiple tables. Alternative term `Model` |
| Term | Description |
| 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 member | Workspace member with specific access permissions. Alternative term `Member` `User` |
| Webhook | A webhook is a mechanism that allows one system to send real-time data to another system or application. It enables automated notifications and data synchronization between different services or platforms by triggering predefined actions or events in response to specific events or updates in the source system. |
| Workspace Owner | Member who had created workspace. There can be only one owner for a workspace & ownership is non-transferable |
| Base member | Base member with specific access permissions. Alternative term `Member` `User` |
| Base Owner | Member who had created base. There can be only one owner for a base & ownership is non-transferable |
| Modal | In the context of user interfaces, a modal is a type of dialog or overlay that appears on top of the main content or interface and requires user interaction before the user can proceed. Modals are often used to gather user input, display alerts, or confirm actions. They typically "block" the rest of the interface until the user dismisses them, making them a focused and attention-grabbing element |
| Workspace member | Workspace member with specific access permissions. Alternative term `Member` `User` |
| 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 |

39
packages/noco-docs/docs/020.getting-started/040.keyboard-shortcuts.md

@ -6,7 +6,11 @@ keywords: ['keyboard shortcuts', 'shortcuts', 'keyboard']
## Quick Actions
Cmd+K (Ctrl+K on Windows) is a keyboard shortcut to quickly navigate between different workspace, table, view, or a menu items. For example, if you want to quickly navigate to the "API Tokens" page, you can open Quick Actions menu using ⌘+K, type "Token" in the search box and press enter.
:::note
This feature is available only in NocoDB Cloud hosted version.
:::
`⌘` + `K` (or `Ctrl` + `K` on Windows) is a keyboard shortcut to quickly navigate between different workspace, table, view, or a menu items. For example, if you want to quickly navigate to the "API Tokens" page, you can open Quick Actions menu using ⌘+K, type "Token" in the search box and press enter.
This shortcut is often referred to as "Command-K". It's a great way to save time when you're navigating around NocoDB.
@ -20,6 +24,39 @@ To navigate within ⌘+K menu,
- Use `Backspace` to move to parent menu
- Use `Esc` to close the menu
## Recent Views
:::note
This feature is available only in NocoDB Cloud hosted version.
:::
Access recently visited views quickly using `⌘` + `L` (or `Ctrl` + `L` on Windows). Search results will be displayed in a modal window; click on the result to open the view.
![Recent Views](/img/v2/cmd-l.png)
To navigate within ⌘+K menu,
- Use `↑` `↓` to navigate between listed items
- Use `Enter` to select an item
- Use `Backspace` to move to parent menu
- Use `Esc` to close the menu
## Search in Docs
:::note
This feature is available only in NocoDB Cloud hosted version.
:::
Quickly search through docs from within NocoDB UI using `⌘` + `J` (or `Ctrl` + `J` on Windows). Search results will be displayed in a modal window; click on the result to open the page in a new tab.
To navigate within ⌘+K menu,
- Use `↑` `↓` to navigate between listed items
- Use `Enter` to select an item
- Use `Backspace` to move to parent menu
- Use `Esc` to close the menu
![Search in Docs](/img/v2/cmd-j.png)
## General shortcuts
| Key | Behaviour |

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

@ -4,17 +4,14 @@ description: 'This article briefs the concept of workspaces in NocoDB.'
tags: ['Workspaces', 'Overview']
---
NocoDB workspaces are a crucial feature for organizing and managing your data effectively:
1. **Workspace Isolation**: Each workspace contains its own set of bases, keeping your data separate and well-organized.
2. **Member Control**: Workspaces have their own members and permissions, allowing you to control who can access and modify data within each workspace.
3. **Customized Settings**: Workspaces offer unique settings and billing options, letting you customize configurations to suit specific needs.
4. **Base Association**: Bases are tied exclusively to one workspace and can't be moved between workspaces, ensuring data integrity.
5. **Member Flexibility**: Members can be part of multiple workspaces, enabling versatile collaboration across different bases. You can also fine-tune their roles within each workspace.
In NocoDB, workspaces play a pivotal role in facilitating collaborative and organized data management. A workspace serves as a container for one or more bases, allowing users to bring together interconnected tables, views, and various elements into a unified and coherent entity. Each workspace can house multiple bases, enabling users to categorize and structure their data in a way that suits their specific needs. Whether you're tracking projects, managing databases, or organizing information, NocoDB's workspaces provide the flexibility and organization required to make data-driven decisions and foster collaboration within your team. Additionally, workspaces allow for the assignment of specific access permissions to workspace members, ensuring that data security and privacy are maintained while enabling effective teamwork.
Some key points to note about workspaces are:
1. Each workspace contains its own set of bases, keeping your data separate and well-organized.
2. Workspaces have their own set of members and permissions, allowing you to control who can access and modify data within each workspace.
3. Workspaces offer unique settings and billing options, letting you customize configurations to suit specific needs.
4. Bases are tied exclusively to one workspace and can't be moved between workspaces, ensuring data integrity.
5. Members can be part of multiple workspaces. You can also fine-tune their roles within each workspace.
In summary, NocoDB workspaces streamline data management and member control, providing the flexibility and oversight necessary for various projects and teams.

BIN
packages/noco-docs/static/img/v2-unannotated/cmd-j.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 669 KiB

BIN
packages/noco-docs/static/img/v2-unannotated/cmd-k.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 603 KiB

BIN
packages/noco-docs/static/img/v2-unannotated/cmd-l.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 683 KiB

BIN
packages/noco-docs/static/img/v2/cmd-j.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 669 KiB

BIN
packages/noco-docs/static/img/v2/cmd-k.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 266 KiB

After

Width:  |  Height:  |  Size: 603 KiB

BIN
packages/noco-docs/static/img/v2/cmd-l.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 683 KiB

Loading…
Cancel
Save