Improved user guide, added CI vale for docs (#2308)

* restructured user guide, minor fixes

* added index file for user guide

* github actions for vale

* testing workflow

* CI vale

* changes as per vale's suggestions

* set CI vale on pull request

* adding homebrew script to macos infra setup file

* fix CI errors

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* testing vale

* vale testing complete

* vale cleanup

* vale test

* vale test for github-pr-check

* vale test for github-pr-check

* vale test for github-pr-check

* vale test for github-pr-check

* testing vale warnings

* testing vale warnings

* testing vale warnings

* testing vale warnings

* testing vale warnings

* testing vale warnings

* testing vale warnings

* swizzled doc cards to add icons

* Align CI params to other CIs

---------

Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
This commit is contained in:
Nimra Ahmed
2023-11-03 21:02:30 +05:00
committed by GitHub
parent c397619100
commit 2221c68dff
52 changed files with 219 additions and 11 deletions

View File

@ -0,0 +1,4 @@
{
"label": "Basics",
"position": 1
}

View File

@ -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 built-in 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>