Migrate to a monorepo structure (#2909)
This commit is contained in:
4
packages/twenty-docs/docs/user-guide/_category_.json
Normal file
4
packages/twenty-docs/docs/user-guide/_category_.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "User Guide",
|
||||
"position": 3
|
||||
}
|
||||
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Basics",
|
||||
"position": 1
|
||||
}
|
||||
@ -0,0 +1,42 @@
|
||||
---
|
||||
title: Creating Custom Objects
|
||||
sidebar_position: 1
|
||||
sidebar_custom_props:
|
||||
icon: TbAugmentedReality
|
||||
---
|
||||
|
||||
Objects are structures that allow you to store data (records, attributes, and values) specific to an organization. Twenty provides both standard and custom objects.
|
||||
|
||||
Standard objects are in-built objects with a set of attributes available for all users. All workspaces come with three standard objects by default: People, Companies, and Opportunities. Standard objects have standard fields that are also available for all Twenty users, like Account Owner and URL.
|
||||
|
||||
Custom objects are objects that you can create to store information that is unique to your organization. They are not built-in; members of your workspace can create and customize custom objects to hold information that standard objects aren't suitable for. For example, if you're Airbnb, you may want to create a custom object for Listings or Reservations.
|
||||
|
||||
## Creating a new custom object
|
||||
|
||||
To create a new custom object:
|
||||
|
||||
1. Go to Settings in the sidebar on the left.
|
||||
2. Under Workspace, go to Data model. Here you'll be able to see an overview of all your existing Standard and Custom objects (both active and disabled).
|
||||
<br/>
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img src="/img/user-guide/view-all-objects.png" alt="View all objects" />
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
||||
3. Click on `+ New object` at the top, then choose Custom as the object type. Enter the name (both singular and plural) and description for your custom object and hit Save (at the top right). Using Listing as an example of custom object, the singular would be "listing" and the plural would be "listings" along with a description like "Listings that hosts created to showcase their property."
|
||||
|
||||
<br/>
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img src="/img/user-guide/create-custom-object.gif" alt="Create custom object" />
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
||||
4. Once you create your custom object, you'll be able to manage it. You can edit the name and description, view the different fields, and add more fields.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img src="/img/user-guide/manage-custom-object.png" alt="Create custom object" />
|
||||
</div>
|
||||
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Integrations",
|
||||
"position": 2
|
||||
}
|
||||
@ -0,0 +1,27 @@
|
||||
---
|
||||
title: Connect Twenty and Zapier
|
||||
sidebar_position: 3
|
||||
sidebar_custom_props:
|
||||
icon: TbBrandZapier
|
||||
---
|
||||
|
||||
:::caution
|
||||
|
||||
Twenty integration is currently being registered in the public Zapier repository, you may not find it until the publishing process is complete.
|
||||
|
||||
:::
|
||||
|
||||
Sync Twenty with 3000+ apps using [Zapier](https://zapier.com/), and automate your work. Here's how you can connect Twenty to Zapier:
|
||||
|
||||
1. Go to Zapier and log in.
|
||||
2. Click on `+ Create Zap` in the left sidebar.
|
||||
3. Choose the application you want to set as the trigger. A trigger refers to an event that starts the automation.
|
||||
4. Select Twenty as the action. An action is the event performed whenever an application triggers an automation. [Learn more about triggers and actions in Zapier.](https://zapier.com/how-it-works)
|
||||
5. Once you choose the Twenty account that you want to use for your automation, you'll have to authorize it by adding an API key. You can learn [how to generate your API key here.](generating-api-keys.mdx)
|
||||
6. Enter your API key and click on 'Yes, Continue to Twenty.'
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img src="/img/user-guide/connect-zapier.png" alt="Connect Twenty to Zapier" />
|
||||
</div>
|
||||
|
||||
You can now continue creating your automation!
|
||||
@ -0,0 +1,26 @@
|
||||
---
|
||||
title: Generating an API Key
|
||||
sidebar_position: 2
|
||||
sidebar_custom_props:
|
||||
icon: TbApi
|
||||
---
|
||||
|
||||
To generate an API key:
|
||||
|
||||
1. Go to Settings in the sidebar on the left.
|
||||
2. Under Workspace, go to Developers. Here, you'll see a list of active keys that you or your team have created.
|
||||
3. To generate a new key, click on `+ Create key` on the top right.
|
||||
4. Give your API key a name, an expiration date, and a logo.
|
||||
5. Hit save to see your API key.
|
||||
6. Since the key is only visible once, make sure you store it somewhere safe.
|
||||
|
||||
:::caution Note
|
||||
|
||||
Since your API key contains sensitive information, you shouldn't share it with services you don't fully trust. If leaked, someone can use it maliciously. If you think your API key is no longer secure, make sure you disable it and generate a new one.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
## Regenerating API key
|
||||
|
||||
To regenerate an API key, click on the key you want to regenerate. You'll then be able to see a button to regenerate the API key.
|
||||
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Others",
|
||||
"position": 3
|
||||
}
|
||||
20
packages/twenty-docs/docs/user-guide/others/glossary.mdx
Normal file
20
packages/twenty-docs/docs/user-guide/others/glossary.mdx
Normal file
@ -0,0 +1,20 @@
|
||||
---
|
||||
title: Glossary
|
||||
sidebar_position: 3
|
||||
sidebar_custom_props:
|
||||
icon: TbVocabulary
|
||||
---
|
||||
|
||||
### Company & People
|
||||
The CRM has two fundamental types of records:
|
||||
- A `Company` represents a business or organization.
|
||||
- `People` represent your company's current and prospective customers or clients.
|
||||
|
||||
### Pipelines
|
||||
A `Pipeline` is a way to track a business process. Pipelines are present within a *module* and have *stages*:
|
||||
- A **module** contains the logic for a certain business process (for example: sales, recruiting).
|
||||
- **Stages** map the steps in your process (for example: new, ongoing, won, lost).
|
||||
|
||||
### Workspace
|
||||
A `Workspace` typically represents a company using Twenty.
|
||||
It has a single domain name, which is typically the domain name your company uses for employee email addresses.
|
||||
37
packages/twenty-docs/docs/user-guide/user-guide.mdx
Normal file
37
packages/twenty-docs/docs/user-guide/user-guide.mdx
Normal file
@ -0,0 +1,37 @@
|
||||
---
|
||||
title: User Guide
|
||||
displayed_sidebar: userSidebar
|
||||
sidebar_class_name: hidden
|
||||
sidebar_position: 0
|
||||
sidebar_custom_props:
|
||||
icon: TbUsers
|
||||
isSidebarRoot: true
|
||||
---
|
||||
|
||||
# Welcome to Twenty's User Guide
|
||||
|
||||
The purpose of this user guide is to help you learn how you can use Twenty to build the CRM you want.
|
||||
|
||||
This quick-start guide walks you through the basics.
|
||||
|
||||
## Quick Search
|
||||
|
||||
You'll see a search bar at the top of your sidebar. You can also bring up the command bar with the `cmd`/`ctrl` + `k` shortcut to navigate through your workspace, and find people, companies, notes, and more.
|
||||
|
||||
The command bar also supports other shortcuts for navigation.
|
||||
|
||||
## Create Pre-filtered Views
|
||||
|
||||
Twenty allows you to add filters to see data that meets certain criteria and hides the rest.
|
||||
|
||||
To create a filter in your workspace, click Filter at the top right and select the attribute you'd like to filter your records by. Create your filter and then save changes in a new view by clicking `+ Create view`.
|
||||
|
||||
The filtered view is now available to your whole team.
|
||||
|
||||
## Add Stages For Opportunities
|
||||
|
||||
You can also add more stages to the opportunities board.
|
||||
|
||||
On the Opportunities page, click on Options, Stages, then `+ Add Stage`.
|
||||
|
||||
You can also edit the stage by clicking on the name.
|
||||
Reference in New Issue
Block a user