Skip to content

Commit

Permalink
Merge branch 'main' into issue-3103
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasbordeau committed Dec 26, 2023
2 parents c782576 + 58a62e8 commit b81edd7
Show file tree
Hide file tree
Showing 96 changed files with 6,563 additions and 120 deletions.

This file was deleted.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
"packages/twenty-docs",
"packages/twenty-server",
"packages/twenty-utils",
"packages/twenty-zapier"
"packages/twenty-zapier",
"packages/twenty-website"
]
},
"devDependencies": {
Expand Down
4 changes: 2 additions & 2 deletions packages/twenty-docs/docs/start/self-hosting/self-hosting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Feel free to open issues on [GitHub](https://github.com/twentyhq/twenty/issues/n

Prebuilt images for both front and back-end can be found on [docker hub](https://hub.docker.com/r/twentycrm/).

For correct operation your will need to set [environment variables](enviroment-variables), a example configuration can be found [here](https://github.com/twentyhq/twenty/blob/main/server/.env.example).
For correct operation your will need to set [environment variables](enviroment-variables), a example configuration can be found [here](https://github.com/twentyhq/twenty/blob/main/packages/twenty-server/.env.example).


## Render
Expand All @@ -29,4 +29,4 @@ A joint Docker image - containing both the frontend and server - that you can de
## Railway
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/YWGqza?referralCode=3CLObs)

-->
-->
11 changes: 6 additions & 5 deletions packages/twenty-docs/docs/user-guide/basics/custom objects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_custom_props:
icon: TbAugmentedReality
---

import ThemedImage from '@theme/ThemedImage';

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.
Expand All @@ -19,13 +21,12 @@ To create a new custom object:
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>

<ThemedImage sources={{light: "/img/user-guide/view-all-objects-light.png", dark:"/img/user-guide/view-all-objects-dark.png"}} style={{width:'100%', maxWidth:'800px'}}/>

<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."
3. Click on `+ New object` at the top, then choose Custom as the object type. Enter the name (both singular and plural), choose an icon, and add a 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/>

Expand All @@ -35,7 +36,7 @@ To create a new custom object:

<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.
4. Once you create your custom object, you'll be able to manage it. You can edit the name, icon 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" />
Expand Down
30 changes: 30 additions & 0 deletions packages/twenty-docs/docs/user-guide/basics/notes.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Notes
sidebar_position: 1
sidebar_custom_props:
icon: TbNote
---

import ThemedImage from '@theme/ThemedImage';

Easily create a note to keep track of important information.

## Create Notes

To attach a note to the record, go to the <b>Notes</b> tab of a record page and click on `+ New Note`. You can also format, comment, and upload images to your notes.

<ThemedImage sources={{light: "/img/user-guide/create-new-note-light.png", dark:"/img/user-guide/create-new-note-dark.png"}} style={{width:'100%', maxWidth:'800px'}}/>

## Format Notes

You can format your notes right from the editor. Use markdown syntax, press the `/` key or click on the `+` icon on the editor to see the different block options, such as headings, tables, and lists. You can also attach images to your note.

Highlight the text to see more formatting options like bold, italics, and alignment options.

You can also change the background color and text color of each block to highlight important things in your note. To do so, hover over the block you want to format and click on the `⋮⋮` icon besides the `+` icon. Click on <b>Colors</b> to open up all color options for both the text and the background.

## Delete Notes

To delete a note, open it and click on the trashcan icon on the upper right of the screen. This will permanently delete your note.


50 changes: 50 additions & 0 deletions packages/twenty-docs/docs/user-guide/basics/opportunities.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: Opportunities
sidebar_position: 1
sidebar_custom_props:
icon: TbTargetArrow
---

import ThemedImage from '@theme/ThemedImage';

All opportunities are presented in a Kanban board, where each column represents the stage of your workflow and each card represents a record. For each card, you can list the amount, close date, probability, and the point of contact. You can also move each card between stages as it goes through your workflow.

<ThemedImage sources={{light: "/img/user-guide/all-opportunities-light.png", dark:"/img/user-guide/all-opportunities-dark.png"}} style={{width:'100%', maxWidth:'800px'}}/>

## Add and delete stages

You can add as many stages as you'd like to perfectly capture your entire workflow. To add a new stage, click on <b>Options</b> on the top right, choose <b>Stages</b>, and then click on `+ Add stage`. Name your stage and hit `Enter` to create it. Click on the name of the stage and then on on edit to change the stage's name and color.

To delete a stage, click on the stage name or on the `` icon that appears when you hover over a stage. Click on edit to open the menu and click on <b>Delete</b> at the bottom to permanently delete a stage.

## Filter, update, and sort views

It's easy to add filters and update your view to focus on only the most important things. To add a filter:
- Click <b>Filter</b> on the top right of the opportunities board and select the field you want to filter by (Amount, Close date, Company, Creation Date, Person, Pipeline Step, and Point of Contact).
- Select the filter's condition (is/is not, greater than/lesser than) and then choose the value of the field you want to filter by.
- You can either create a new view or update your current view with the filter in place.
- You can also add another filter by following the same steps or clicking on the `+ Add filter` button on top of the columns.
- To remove a filter condition, simply click on the <b>X</b> next to the attribute you used to filter the records.

<ThemedImage sources={{light: "/img/user-guide/filter-opportunities-light.png", dark:"/img/user-guide/filter-opportunities-dark.png"}} style={{width:'100%', maxWidth:'800px'}}/>

<br/>

You can also sort your records by Close date, Creation date, and Probability. To do so:
- Click on <b>Sort</b> on the top right.
- Choose Ascending or Descending, and then the field you want to sort the records by.
- You can then update your view or create a new one with the sort filter in place.

## Display fields

You can configure your kanban board to display some fields and hide others. By default, the Amount, Close date, Probability, and Point of Contact are all visible. To hide a field, click on <b>Options</b> on the top right, then on <b>Fields</b> to bring up the list of options. Hover over the field you want to hide to bring up the `-` button. Click on it to hide the field.

You can also rearrange the order of fields by holding down the field name and dragging it to where you want it.

<ThemedImage sources={{light: "/img/user-guide/display-fields-light.png", dark:"/img/user-guide/display-fields-dark.png"}} style={{width:'100%', maxWidth:'800px'}}/>

<br/>

You can also hide all the fields, and get an overview of all the opportunities at a glance. To do so, click on <b>Options</b> on the top right and turn on the toggle in front of the <b>Compact view</b> option.

<ThemedImage sources={{light: "/img/user-guide/compact-opportunities-view-light.png", dark:"/img/user-guide/compact-opportunities-view-dark.png"}} style={{width:'100%', maxWidth:'800px'}}/>
18 changes: 18 additions & 0 deletions packages/twenty-docs/docs/user-guide/basics/tasks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Tasks
sidebar_position: 1
sidebar_custom_props:
icon: TbChecklist
---

import ThemedImage from '@theme/ThemedImage';

You can find all the tasks from across your workspace in the <b>Tasks</b> window in your sidebar. You can also find a dedicated tab for Tasks on each record so you can add and edit tasks directly from each record. Alternatively, you can click on the `+` button on the top right of each record page and then click on <b>Task</b> to create a new task.

<ThemedImage sources={{light: "/img/user-guide/create-new-task-light.png", dark:"/img/user-guide/create-new-task-dark.png"}} style={{width:'100%', maxWidth:'800px'}}/>

## Tasks page

Switch between upcoming and completed tasks to get an overview of what's pending and what's already been done.

You can also see the tasks assigned to others by changing the assignee from the top right of the Tasks page, and edit each task to update the content, due dates, and assignee. You can also comment on each task.
7 changes: 5 additions & 2 deletions packages/twenty-docs/docs/user-guide/others/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ A `Pipeline` is a way to track a business process. Pipelines are present within
- 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).

### Views
With views, you can customize how your records are displayed. You can have different filters and sort settings for each view.

### 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.
A `Workspace` typically represents a company using Twenty. It holds all the records and data that you and your team members add to Twenty.
It has a single domain name, which is typically the domain name your company uses for employee email addresses.
39 changes: 39 additions & 0 deletions packages/twenty-docs/docs/user-guide/others/tips.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Tips
sidebar_position: 1
sidebar_custom_props:
icon: TbInfoCircle
---

## Update workspace name & logo

Workspace admins can edit its name and logo in settings.

- From the sidebar, go to <b>Settings</b>.
- Under <b>Workspace</b>, go to <b>General</b>.
- Edit the name and logo. Your changes will be saved automatically.

## Enable dark mode

Not a fan of light mode? Easily switch to dark mode with these steps:

- From the sidebar, go to <b>Settings</b>.
- Under <b>User</b>, go to <b>Appearance</b>.
- Select <b>Dark</b>. Your changes will be saved automatically.

## Account settings

Configure your user account and set your preferences.

- From the sidebar, go to <b>Settings</b>.
- Under <b>User</b>, go to <b>Profile</b> to edit your name and profile picture. You can upload PNGs, GIFs, and JPEGs.
- Manage your accounts and configure your email and calendar settings in <b>Accounts</b>.
- Your changes will be saved automatically.

## Invite & manage members

Admins can easily invite new members any time.

- From the sidebar, go to <b>Settings</b>.
- Under <b>Workspace</b>, go to <b>Members</b>.
- Use the invite link to add more members to your workspace or simply delete existing ones.
34 changes: 29 additions & 5 deletions packages/twenty-docs/docs/user-guide/user-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ sidebar_custom_props:
isSidebarRoot: true
---

import ThemedImage from '@theme/ThemedImage';

# 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.
Expand All @@ -22,7 +22,7 @@ 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.
Twenty allows you to add filters to see data that meets certain criteria and hides the rest. You can apply multiple filters at once.

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`.

Expand All @@ -32,6 +32,30 @@ The filtered view is now available to your whole team.

You can also add more stages to the opportunities board.

On the Opportunities page, click on Options, Stages, then `+ Add Stage`.
On the <b>Opportunities</b> page, click on <b>Options</b>, <b>Stages</b>, then `+ Add Stage`.

You can also edit the stage by clicking on the name.

## Create Notes and Tasks For Each Record

You can attach notes and tasks to each record. With Notes, you can keep a record of any observations, comments, and interactions, and keep track of all items that require action with Tasks.

There are multiple ways to create notes and tasks. Learn more about [Notes](./basics/notes.mdx) and [Tasks](./basics/tasks.mdx).

## Upload Files For Each Record

You can also upload and attach files for each record. To do so, expand a record, and head over to the <b>Files</b> tab. You'll then see the `+ Add file` button.

<ThemedImage sources={{light: "../img/user-guide/attach-files-to-records-light.png", dark:"../img/user-guide/attach-files-to-records-dark.png"}} style={{width:'100%', maxWidth:'800px'}}/>

## Add Records To Favorites

You can add records to your favorites for quick access. To do so, expand the record you want to add, and click on the heart icon on the top right. You'll now be able to see your favorite records in your sidebar right above your workspace.

<ThemedImage sources={{light: "../img/user-guide/view-favorite-records-light.png", dark:"../img/user-guide/view-favorite-records-dark.png"}} style={{width:'100%', maxWidth:'800px'}}/>

## Import data

You can easily import People and Companies data into Twenty from other apps using a .csv, .xslx, or .xsl file. In the <b>Companies</b> or <b>People</b> page, click on <b>Options</b> and then on <b>Import</b>.

You can also edit the stage by clicking on the name.
Upload your file, match the columns, and validate the data to import it.
3 changes: 3 additions & 0 deletions packages/twenty-docs/src/theme/icons.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ export {
TbSelect,
TbToggleRight,
TbTextPlus,
TbTargetArrow,
TbNote,
TbInfoCircle,
TbLink,
TbNavigation,
TbMenu,
Expand Down
Binary file modified packages/twenty-docs/static/img/architecture-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/twenty-docs/static/img/architecture-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/twenty-docs/static/img/contributor/wsl-complete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/twenty-docs/static/img/create-tasks-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/twenty-docs/static/img/create-tasks-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/twenty-docs/static/img/dark-doc-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/twenty-docs/static/img/dark-sign-in.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 1 addition & 8 deletions packages/twenty-docs/static/img/discord-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/twenty-docs/static/img/figma-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/twenty-docs/static/img/follow-your-deals-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/twenty-docs/static/img/follow-your-deals-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/twenty-docs/static/img/light-doc-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/twenty-docs/static/img/light-sign-in.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit b81edd7

Please sign in to comment.