From ebeb355078369444e40e0811ab2fe6b6f6843a2a Mon Sep 17 00:00:00 2001 From: BOHEUS Date: Wed, 15 Jan 2025 21:47:55 +0100 Subject: [PATCH 1/3] Docker and documentation fixes --- packages/twenty-docker/docker-compose.yml | 1 - .../src/content/developers/frontend-development/hotkeys.mdx | 2 +- .../developers/frontend-development/work-with-figma.mdx | 2 +- .../src/content/developers/self-hosting/docker-compose.mdx | 6 +++--- .../src/content/developers/self-hosting/troubleshooting.mdx | 6 +++--- .../src/content/developers/self-hosting/upgrade-guide.mdx | 6 +++++- 6 files changed, 13 insertions(+), 10 deletions(-) diff --git a/packages/twenty-docker/docker-compose.yml b/packages/twenty-docker/docker-compose.yml index 0f32467e2331..8026d8955374 100644 --- a/packages/twenty-docker/docker-compose.yml +++ b/packages/twenty-docker/docker-compose.yml @@ -1,4 +1,3 @@ -version: "3.9" name: twenty services: diff --git a/packages/twenty-website/src/content/developers/frontend-development/hotkeys.mdx b/packages/twenty-website/src/content/developers/frontend-development/hotkeys.mdx index 3e7103ba6808..f3f2c35a374c 100644 --- a/packages/twenty-website/src/content/developers/frontend-development/hotkeys.mdx +++ b/packages/twenty-website/src/content/developers/frontend-development/hotkeys.mdx @@ -16,7 +16,7 @@ For example, if you have a page that listens for the Enter key, and a modal that To handle this problem, we have a custom hook that makes it possible to listen to hotkeys without any conflict. -You place it in a component and it will listen to the hotkeys only when the component is mounted AND when the specified **hotkey scope** is active. +You place it in a component, and it will listen to the hotkeys only when the component is mounted AND when the specified **hotkey scope** is active. ## How to listen for hotkeys in practice ? diff --git a/packages/twenty-website/src/content/developers/frontend-development/work-with-figma.mdx b/packages/twenty-website/src/content/developers/frontend-development/work-with-figma.mdx index 746996ac7fd4..e2c4e4b87e58 100644 --- a/packages/twenty-website/src/content/developers/frontend-development/work-with-figma.mdx +++ b/packages/twenty-website/src/content/developers/frontend-development/work-with-figma.mdx @@ -31,7 +31,7 @@ On the left sidebar, you can access the different pages of Twenty's Figma. This ## Useful Tips -With read-only access, you can't edit the design but you can access all features that will be useful to convert the designs into code. +With read-only access, you can't edit the design, but you can access all features that will be useful to convert the designs into code. ### Use the Dev mode diff --git a/packages/twenty-website/src/content/developers/self-hosting/docker-compose.mdx b/packages/twenty-website/src/content/developers/self-hosting/docker-compose.mdx index 3635ef61a8d5..46ef526f5248 100644 --- a/packages/twenty-website/src/content/developers/self-hosting/docker-compose.mdx +++ b/packages/twenty-website/src/content/developers/self-hosting/docker-compose.mdx @@ -83,7 +83,7 @@ curl -O https://raw.githubusercontent.com/twentyhq/twenty/refs/tags/v0.35.0/pack Start the Docker containers: ```bash -docker-compose up -d +docker compose up -d ``` ### Step 4: Access the Application @@ -158,8 +158,8 @@ We strongly recommend setting up Twenty behind a reverse proxy with SSL terminat For changes to take effect, restart the Docker containers: ```bash - docker-compose down - docker-compose up -d + docker compose down + docker compose up -d ``` #### Considerations diff --git a/packages/twenty-website/src/content/developers/self-hosting/troubleshooting.mdx b/packages/twenty-website/src/content/developers/self-hosting/troubleshooting.mdx index bff94051caf0..69447a57642e 100644 --- a/packages/twenty-website/src/content/developers/self-hosting/troubleshooting.mdx +++ b/packages/twenty-website/src/content/developers/self-hosting/troubleshooting.mdx @@ -90,8 +90,8 @@ If you can't log in after setup: ``` 2. Restart the Docker containers: ```bash - docker-compose down - docker-compose up -d + docker compose down + docker compose up -d ``` Note the database:reset command will completely erase your database and recreate it from scratch. @@ -121,7 +121,7 @@ If you encounter issues not covered in this guide: View container logs for error messages: ```bash - docker-compose logs + docker compose logs ``` - Community Support: diff --git a/packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx b/packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx index f5a879ae7dd5..cf5f49f89a0e 100644 --- a/packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx +++ b/packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx @@ -19,7 +19,9 @@ If you used Docker Compose, follow these steps: 2. Upgrade the version by changing the `TAG` value in the .env file near your docker-compose. -3. Bring Twenty back online with `docker-compose up -d` +3. Bring Twenty back online with `docker compose up -d` + +If you want to upgrade your instance by few versions, e.g. from 0.33.0 to 0.35.0, you have to upgrade your instance by each version, in this example from 0.33.0 to 0.34.0, then from 0.34.0 to 0.35.0. ## Version-specific upgrade steps @@ -75,6 +77,8 @@ The `yarn command:prod cache:flush` command will flush the Redis cache. The `yarn database:migrate:prod` command will apply the migrations to the database structure (core and metadata schemas) The `yarn command:prod upgrade-0.33` takes care of the data migration of all workspaces. +Starting from this version, twenty-postgres image for DB became deprecated and twenty-postgres-spilo is used instead. +If you want to keep using twenty-postgres image, simply replace `twentycrm/twenty-postgres:${TAG}` with `twentycrm/twenty-postgres` in docker-compose.yml. ### v0.31.0 to v0.32.0 From 594fe0f8bec9efb7dd3afd0dd2ce0f7b1be506b5 Mon Sep 17 00:00:00 2001 From: BOHEUS Date: Wed, 15 Jan 2025 21:59:48 +0100 Subject: [PATCH 2/3] Roadmap README --- README.md | 2 +- .../public/images/readme/planner-icon.svg | 55 +++++++++++++++++++ 2 files changed, 56 insertions(+), 1 deletion(-) create mode 100644 packages/twenty-website/public/images/readme/planner-icon.svg diff --git a/README.md b/README.md index 430d5015a2b0..9e7b96fe6205 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

The #1 Open-Source CRM

-

馃寪 Website 路 馃摎 Documentation 路 Discord 路 Figma

+

馃寪 Website 路 馃摎 Documentation 路 Roadmap 路 Discord 路 Figma


diff --git a/packages/twenty-website/public/images/readme/planner-icon.svg b/packages/twenty-website/public/images/readme/planner-icon.svg new file mode 100644 index 000000000000..1715e5eb522f --- /dev/null +++ b/packages/twenty-website/public/images/readme/planner-icon.svg @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file From d6a740291ac3c9a1139f4c294ae4f06f0b40dfbe Mon Sep 17 00:00:00 2001 From: BOHEUS Date: Wed, 15 Jan 2025 22:03:46 +0100 Subject: [PATCH 3/3] Greptile fixes --- .../src/content/developers/frontend-development/hotkeys.mdx | 6 +++--- .../src/content/developers/self-hosting/docker-compose.mdx | 4 ++-- .../src/content/developers/self-hosting/upgrade-guide.mdx | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/twenty-website/src/content/developers/frontend-development/hotkeys.mdx b/packages/twenty-website/src/content/developers/frontend-development/hotkeys.mdx index f3f2c35a374c..c490a2fc1d06 100644 --- a/packages/twenty-website/src/content/developers/frontend-development/hotkeys.mdx +++ b/packages/twenty-website/src/content/developers/frontend-development/hotkeys.mdx @@ -18,7 +18,7 @@ To handle this problem, we have a custom hook that makes it possible to listen t You place it in a component, and it will listen to the hotkeys only when the component is mounted AND when the specified **hotkey scope** is active. -## How to listen for hotkeys in practice ? +## How to listen for hotkeys in practice? There are two steps involved in setting up hotkey listening : 1. Set the [hotkey scope](#what-is-a-hotkey-scope-) that will listen to hotkeys @@ -131,7 +131,7 @@ It's important to use this pattern when you're not sure that just using a useEff Those conflicts can be hard to debug, and it might happen more often than not with useEffects. -## What is a hotkey scope ? +## What is a hotkey scope? A hotkey scope is a string that represents a context in which the hotkeys are active. It is generally encoded as an enum. @@ -171,7 +171,7 @@ export const currentHotkeyScopeState = createState({ But this Recoil state should never be handled manually ! We'll see how to use it in the next section. -## How is it working internally ? +## How is it working internally? We made a thin wrapper on top of [react-hotkeys-hook](https://react-hotkeys-hook.vercel.app/docs/intro) that makes it more performant and avoids unnecessary re-renders. diff --git a/packages/twenty-website/src/content/developers/self-hosting/docker-compose.mdx b/packages/twenty-website/src/content/developers/self-hosting/docker-compose.mdx index 46ef526f5248..fa2f2bc63d17 100644 --- a/packages/twenty-website/src/content/developers/self-hosting/docker-compose.mdx +++ b/packages/twenty-website/src/content/developers/self-hosting/docker-compose.mdx @@ -158,8 +158,8 @@ We strongly recommend setting up Twenty behind a reverse proxy with SSL terminat For changes to take effect, restart the Docker containers: ```bash - docker compose down - docker compose up -d + docker compose down + docker compose up -d ``` #### Considerations diff --git a/packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx b/packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx index cf5f49f89a0e..57c9765ccf6a 100644 --- a/packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx +++ b/packages/twenty-website/src/content/developers/self-hosting/upgrade-guide.mdx @@ -21,7 +21,7 @@ If you used Docker Compose, follow these steps: 3. Bring Twenty back online with `docker compose up -d` -If you want to upgrade your instance by few versions, e.g. from 0.33.0 to 0.35.0, you have to upgrade your instance by each version, in this example from 0.33.0 to 0.34.0, then from 0.34.0 to 0.35.0. +If you want to upgrade your instance by few versions, e.g. from 0.33.0 to 0.35.0, you have to upgrade your instance sequentially, in this example from 0.33.0 to 0.34.0, then from 0.34.0 to 0.35.0. ## Version-specific upgrade steps