Commit Graph

101 Commits

Author SHA1 Message Date
Benedikt Kleiner
d27f16d97a
docs: mention prebuilt images (#2493)
docs: mention prebuilt images, remove docker build instructions
2023-11-14 15:09:23 +01:00
brendanlaschke
448f256a35
Add env variable docs (#2440)
* - add env variable docs

* - danger.js rule

* - fix value

* Fix Danger CI setup

* Add token in CI

---------

Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
2023-11-14 10:41:09 +01:00
Shiv Tyagi
2befd0ff14
infra: add make commands for provisioning postgres in macos and linux (#2436)
* infra: add make commands for provisioning postgres in macos and linux

* docs: update commands for provisioning postgres on linux and macos
2023-11-12 10:26:12 +01:00
Lucas Bordeau
6e7ad5eabc
Update yarn-setup.mdx (#2424)
Added troubleshooting use case on SQL database init error.
2023-11-10 15:20:55 +01:00
bosiraphael
7aa6b20418
Adding the possibility to add multiple ui components in the live code editor in the docs (#2381)
* working

* forgot docs folder

* modify according to comments
2023-11-07 12:33:40 +01:00
Nimra Ahmed
398a8d732d
changes as per vale warnings (#2353)
* changes as per vale warnings

* changes acc to feedback
2023-11-07 11:39:29 +01:00
Charles Bochet
e70ef58f97
Live code editor for UI docs (#2351)
* Docausaurus code live editor test

* Docusaurus sandpack test

* Fix setup

* Delete files

* Fixes

* Complete work

* Fix config

* Fix config

---------

Co-authored-by: bosiraphael <raphael.bosi@gmail.com>
2023-11-03 23:09:20 +01:00
Nimra Ahmed
2221c68dff
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>
2023-11-03 17:02:30 +01:00
Nimra Ahmed
a523190943
User guide & vale setup (#2260)
* refactored Storybook UI

* refactored Storybook UI

* removed extra cards from the doc, added card for ui components

* added hover behavior to doc page & made it look selected

* separate storybook docs and tests

* separating storybook tests and docs

* fixed spelling errors in docs

* Final round of edits for frontend, added backend folder architecture

* Created CODE_OF_CONDUCT.md

* Add code of conduct to contributing.md

* doc changes

* fixed broken links

* doc addition and changes

* introduce user guide & graphql api

* set up vale, added to docs

* vale config file

* revised backend best practices

* connecting zapier and twenty

* added warning for zapier
2023-10-30 18:01:58 +01:00
dependabot[bot]
7cb58eae4d
build(deps): bump @babel/traverse from 7.21.4 to 7.23.2 in /docs (#2255)
Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.21.4 to 7.23.2.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse)

---
updated-dependencies:
- dependency-name: "@babel/traverse"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-30 17:59:47 +01:00
rbutler-us
6640f2a651
[Docs] Update 'self-hosting options' link on getting-started.mdx (#2267)
Update 'self-hosting options' link on getting-started.mdx

When browsing from: 
https://docs.twenty.com/start/getting-started/

The link with text "self-hosting options" lands on a 404 page with this address:
https://docs.twenty.com/start/getting-started/self-hosting

Adding '/start/' to the beginning of the URL fixes this. 

Note: if your browser automatically redirects from:
https://docs.twenty.com/start/getting-started/
to:
https://docs.twenty.com/start/getting-started

Then the relative document URL will work as expected. When adding the trailing slash, the link breaks.
2023-10-30 10:16:17 +01:00
Lucas Bordeau
14ae8da424
Fix database experience (#2263) 2023-10-27 17:48:06 +02:00
brendanlaschke
6a72c14af3
Use zod instead of yup (#2254)
* use zod instead of yup

* doc

* lint
2023-10-27 10:26:32 +02:00
martmull
d61511262e
2060 create a new api key (#2206)
* Add folder for api settings

* Init create api key page

* Update create api key page

* Implement api call to create apiKey

* Add create api key mutation

* Get id when creating apiKey

* Display created Api Key

* Add delete api key button

* Remove button from InputText

* Update stuff

* Add test for ApiDetail

* Fix type

* Use recoil instead of router state

* Remane route paths

* Remove online return

* Move and test date util

* Remove useless Component

* Rename ApiKeys paths

* Rename ApiKeys files

* Add input text info testing

* Rename hooks to webhooks

* Remove console error

* Add tests to reach minimum coverage
2023-10-24 16:14:54 +02:00
Nimra Ahmed
515ef25a72
Changes to documentation (#2209)
* refactored Storybook UI

* refactored Storybook UI

* removed extra cards from the doc, added card for ui components

* added hover behavior to doc page & made it look selected

* separate storybook docs and tests

* separating storybook tests and docs

* fixed spelling errors in docs

* Final round of edits for frontend, added backend folder architecture

* Created CODE_OF_CONDUCT.md

* Add code of conduct to contributing.md

* doc changes

* fixed broken links

* doc addition and changes

* introduce user guide & graphql api
2023-10-24 11:36:43 +02:00
Nimra Ahmed
cb6ee90fa6
Doc addition & changes (#2152)
* refactored Storybook UI

* refactored Storybook UI

* removed extra cards from the doc, added card for ui components

* added hover behavior to doc page & made it look selected

* separate storybook docs and tests

* separating storybook tests and docs

* fixed spelling errors in docs

* Final round of edits for frontend, added backend folder architecture

* Created CODE_OF_CONDUCT.md

* Add code of conduct to contributing.md

* doc changes

* fixed broken links

* doc addition and changes
2023-10-20 15:47:44 +02:00
Nimra Ahmed
bea9d0835b
Doc changes (#2124)
* refactored Storybook UI

* refactored Storybook UI

* removed extra cards from the doc, added card for ui components

* added hover behavior to doc page & made it look selected

* separate storybook docs and tests

* separating storybook tests and docs

* fixed spelling errors in docs

* Final round of edits for frontend, added backend folder architecture

* Created CODE_OF_CONDUCT.md

* Add code of conduct to contributing.md

* doc changes

* fixed broken links
2023-10-19 16:32:29 +02:00
Nimra Ahmed
1cd91e60fa
Doc changes (#2106)
* refactored Storybook UI

* refactored Storybook UI

* removed extra cards from the doc, added card for ui components

* added hover behavior to doc page & made it look selected

* separate storybook docs and tests

* separating storybook tests and docs

* fixed spelling errors in docs

* Final round of edits for frontend, added backend folder architecture

* Created CODE_OF_CONDUCT.md

* Add code of conduct to contributing.md
2023-10-18 18:00:52 +02:00
martmull
54735c4880
2038 zapier integration 1 initialize a zapier app with a twenty related account (#2089)
* Add doc for Zapier development

* Add twenty-zapier package

* Install zapier packages

* Update doc

* Add twenty-zapier app

* Update doc

* Update apiKey slug

* Update integration

* Update create people to person

* Update version

* Fix lint

* Remove useless comments

* Update docs

* Update version

* Update naming

* Add prettier

* Simplify docs

* Remove twenty related stuff from public doc

* Use typescript boilerplate

* Update details
2023-10-17 21:00:20 +02:00
Aasim Attia
88438e8094
apply database:init (#2079) 2023-10-17 16:39:48 +02:00
Jérémy M
4a96ae225e
feat: easier makefile commands (#2077)
* feat: easier makefile commands

* fix: cleaner command
2023-10-17 10:38:10 +02:00
Nimra Ahmed
a6542719df
Addresses issue #1906 (#2074)
* refactored Storybook UI

* refactored Storybook UI

* removed extra cards from the doc, added card for ui components

* added hover behavior to doc page & made it look selected

* separate storybook docs and tests

* separating storybook tests and docs
2023-10-16 22:06:07 +02:00
gitstart-twenty
07ae0fa76c
Chore(server): Enable local database installation on MacOS (#2057)
* Enable local database installation on MacOS

Co-authored-by: v1b3m <vibenjamin6@gmail.com>

* Fix script

---------

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Charles Bochet <charles@twenty.com>
2023-10-16 22:02:37 +02:00
Charles Bochet
160b7039d9 Complete win script setup 2023-10-14 22:43:17 +02:00
Charles Bochet
986082d7a7 Complete win script setup 2023-10-14 22:41:18 +02:00
Nimra Ahmed
fa9303f545
Refactored Storybook UI (#2020)
* refactored Storybook UI

* refactored Storybook UI

* removed extra cards from the doc, added card for ui components
2023-10-14 21:22:47 +02:00
Charles Bochet
04090446cc Update install on docker 2023-10-14 14:03:37 +02:00
Charles Bochet
77729e4d4b
Update installation doc (#2019)
* Update installation doc

* Update install scripts

* Update install scripts
2023-10-14 13:43:45 +02:00
Charles Bochet
258685467b
Refactor UI folder (#2016)
* Added Overview page

* Revised Getting Started page

* Minor revision

* Edited readme, minor modifications to docs

* Removed sweep.yaml, .devcontainer, .ergomake

* Moved security.md to .github, added contributing.md

* changes as per code review

* updated contributing.md

* fixed broken links & added missing links in doc, improved structure

* fixed link in wsl setup

* fixed server link, added https cloning in yarn-setup

* removed package-lock.json

* added doc card, admonitions

* removed underline from nav buttons

* refactoring modules/ui

* refactoring modules/ui

* Change folder case

* Fix theme location

* Fix case 2

* Fix storybook

---------

Co-authored-by: Nimra Ahmed <nimra1408@gmail.com>
Co-authored-by: Nimra Ahmed <50912134+nimraahmed@users.noreply.github.com>
2023-10-14 00:04:29 +02:00
Subash-Lamichhane
92b34a76a2
fixed typo in docs\docs\contributor\frontend\advanced\best-practices.mdx (#1993) 2023-10-13 09:18:58 +02:00
Nimra Ahmed
13db1bd0a6
Improvements to the doc (#1989)
* Added Overview page

* Revised Getting Started page

* Minor revision

* Edited readme, minor modifications to docs

* Removed sweep.yaml, .devcontainer, .ergomake

* Moved security.md to .github, added contributing.md

* changes as per code review

* updated contributing.md

* fixed broken links & added missing links in doc, improved structure

* fixed link in wsl setup

* fixed server link, added https cloning in yarn-setup

* removed package-lock.json

* added doc card, admonitions

* removed underline from nav buttons
2023-10-13 09:13:13 +02:00
Nimra Ahmed
ae32a2da3b
Revised contributing.md, edited docs (#1951)
* Added Overview page

* Revised Getting Started page

* Minor revision

* Edited readme, minor modifications to docs

* Removed sweep.yaml, .devcontainer, .ergomake

* Moved security.md to .github, added contributing.md

* changes as per code review

* updated contributing.md

* fixed broken links & added missing links in doc, improved structure

* fixed link in wsl setup

* fixed server link, added https cloning in yarn-setup
2023-10-10 12:33:17 +02:00
gitstart-twenty
77a1840611
Chore(front): Create a custom eslint rule for Props naming (#1904)
Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Matheus <matheus_benini@hotmail.com>
Co-authored-by: bosiraphael <raphael.bosi@gmail.com>
2023-10-09 16:31:13 +02:00
Charles Bochet
150d1a880c Fix iframe not loading on ui components doc 2023-10-08 13:35:33 +02:00
Charles Bochet
edc060fce7
Introduce UI Components documentation (#1926)
* new contributor guide folder architecture

* update content pass 1

* Prepare UI component folder to receive componentns

* Add component doc example for button

* Fix broken links

* Fix broken links

* Fix images
2023-10-08 13:21:54 +02:00
Nimra Ahmed
7b6ee4e0bf
Update README and Documentation (#1875)
* Added Overview page

* Revised Getting Started page

* Minor revision

* Edited readme, minor modifications to docs

* Removed sweep.yaml, .devcontainer, .ergomake

* Moved security.md to .github, added contributing.md

* changes as per code review
2023-10-07 11:24:44 +02:00
BOHEUS
10c39e4501
Update troubleshooting.mdx (#1895)
Updated troubleshooting.mdx with possible solution to Docker related problems
2023-10-06 11:12:42 +02:00
Gaurav
b8282e6789
Added script to setup database locally on Linux/WSL (#1879)
* Created script to install and setup PostgreSQL database for Linux/WSL

* Updated Docs
2023-10-05 16:17:27 +02:00
brendanlaschke
59a7e7ead3
Add troubleshooting doc (#1852)
* - add troubleshooting doc

* fix duplicate
2023-10-04 15:07:02 +02:00
Aman
bc3fe59312
feat: added an enlint rule to enforce no-type-import (#1838)
* feat: added an enlint rule to enforce no-type-import

* Update style-guide.mdx

---------

Co-authored-by: aman1357 <101919821+aman1357@users.noreply.github.com>
2023-10-04 11:06:54 +02:00
bosiraphael
35fb2576b7
added figma link to README.md (#1835)
* added figma link to README.md

* added figma to the recommended extensions for the project

* updated useful tips in 'work with Figma' section of the docs to add Figma extension for VSCode

* removing yarn.lock

* modified Figma extension docs in 'Work with Figma'

* added Mdx Preview extension to recommended extensions
2023-10-03 12:50:05 +02:00
Charles Bochet
ab4f978a00 Update documentation nav font-size 2023-09-29 19:16:38 +02:00
Thaïs
ae0acd508a
docs: add page level sidebar (#1749)
* POC: docs: add page level sidebar

Closes #1341

* docs: hide level 1 test page from navbar
2023-09-29 17:50:21 +02:00
Thaïs
1c35ccce4e
docs: redesign docs collapsible categories (#1748)
* docs: redesign docs collapsible categories

Closes #1341

* Fix people creation from People table page

---------

Co-authored-by: Charles Bochet <charles@twenty.com>
2023-09-29 16:22:04 +02:00
gitstart-twenty
ba86be2c5b
Remove the {...props} pattern and props coupling, and create an eslint rule for that (#1733)
* Remove the {...props} pattern and props coupling, and create an eslint rule for that

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Thiago Nascimbeni <tnascimbeni@gmail.com>

* Add another test to the new rule

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Thiago Nascimbeni <tnascimbeni@gmail.com>

---------

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Thiago Nascimbeni <tnascimbeni@gmail.com>
2023-09-26 11:05:33 +02:00
Charles Bochet
8d8c81c02c
Add Figma documentation (#1705) 2023-09-21 14:56:28 -07:00
Charles Bochet
2d758c990b
Fix merge issue flexible backend (#1685)
* Fix merge issue flexible backend

* Fix tests

* Try fix tests

* Try fix tests
2023-09-20 19:11:21 -07:00
Rajesh Kumar Padhy
ff4a2074e6
Update local-setup.mdx: Fix typo (#1646) 2023-09-19 11:51:47 +02:00
gitstart-twenty
00a3c8ca2b
Change to using arrow functions (#1603)
* Change to using arrow functions

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Matheus <matheus_benini@hotmail.com>

* Add lint rule

---------

Co-authored-by: v1b3m <vibenjamin6@gmail.com>
Co-authored-by: Matheus <matheus_benini@hotmail.com>
Co-authored-by: Charles Bochet <charles@twenty.com>
2023-09-15 18:41:10 -07:00
Lucas Bordeau
28ca9a9e49
Refactor/new menu item (#1448)
* wip

* finished

* Added disabled

* Fixed disabled

* Finished cleaning

* Minor fixes from merge

* Added docs

* Added PascalCase

* Fix from review

* Fixes from merge

* Fix lint

* Fixed storybook tests
2023-09-06 16:41:26 +02:00