Add redis to contributor guide #7369
Conversation
| @@ -10,8 +10,6 @@ | |||
| "@blocknote/react": "^0.15.3", | |||
| "@codesandbox/sandpack-react": "^2.13.5", | |||
| "@dagrejs/dagre": "^1.1.2", | |||
| "@docusaurus/core": "^3.1.0", | |||
There was a problem hiding this comment.
we are not using Docusaurus anymore
| @@ -14,6 +14,8 @@ | |||
| "database:generate:pg": "npx drizzle-kit generate:pg --config=src/database/drizzle-posgres.config.ts" | |||
| }, | |||
| "dependencies": { | |||
| "@docsearch/react": "^3.6.2", | |||
| "gray-matter": "^4.0.3", | |||
There was a problem hiding this comment.
as we deprecate docusaurus, we need to re-add docsearch (search) and gray-matter (mdx header parsing)
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
This PR adds Redis setup instructions to the local setup guide for Twenty, enhancing the contributor onboarding process.
- Added Step 4 in
packages/twenty-website/src/content/developers/local-setup.mdxfor Redis database setup, including platform-specific installation instructions - Removed Docusaurus-related dependencies from the root
package.json, indicating a shift in documentation tooling - Added '@docsearch/react' and 'gray-matter' dependencies to
packages/twenty-website/package.json, suggesting new search and markdown processing capabilities - Modified styling in
ArticleContent.tsxandlayout.cssto improve code block appearance and remove inline code styling
5 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings
| @@ -10,6 +10,12 @@ const StyledContent = styled.div` | |||
| flex: 1; | |||
| max-width: 950px; | |||
|
|
|||
| pre { | |||
| background: #1414140a; | |||
There was a problem hiding this comment.
style: Consider using a CSS variable for the background color to maintain consistency with the theme
| @@ -10,6 +10,12 @@ const StyledContent = styled.div` | |||
| flex: 1; | |||
| max-width: 950px; | |||
|
|
|||
| pre { | |||
| background: #1414140a; | |||
| padding: 4px; | |||
There was a problem hiding this comment.
style: 4px padding might be too small for code blocks. Consider increasing to 8px or 12px for better readability
| font-weight: 500; | ||
| text-decoration: none; | ||
| } |
There was a problem hiding this comment.
style: Consider keeping or updating the code element styling to maintain visual distinction for code snippets.
| @@ -138,19 +140,35 @@ You can access the database at [localhost:5432](localhost:5432), with user `twen | |||
| </ArticleTab> | |||
| </ArticleTabs> | |||
|
|
|||
| ## Step 4: Set up a Redis Database (cache) | |||
There was a problem hiding this comment.
Since we offer a docker PostgreSQL. Can we offer a docker option also? @charlesBochet
There was a problem hiding this comment.
@hozza We actually want to get rid of docker in the contributor guide.
While I personally think docker is the best way, most of the contributors are not at ease with it and this was generating too much friction on the install (many thread on Discord). We've chosen not to maintain docker containers ourselves.
Setting up redis with docker is straightforward and I believe that contributors wanting to provision it through docker will manage to do it by themselves.
I would say docker setup should not be part of the local setup guide and we will (or the community!) will likely write a blog post about it at some point
There was a problem hiding this comment.
Thanks, your comments here may help to explain this as well #7370
## Context We are adding redis to default twenty configuration. ## What 1. This PR sets up the local setup for contributors accordingly 2. I'm also updating the code blocks guide: Before: <img width="921" alt="image" src="https://github.com/user-attachments/assets/2203cc99-b5a5-4d05-a8b1-98a348aee9df"> After: <img width="921" alt="image" src="https://github.com/user-attachments/assets/5b3e6f34-723d-4309-888b-c02ce794891d">
Context
We are adding redis to default twenty configuration.
What
This PR sets up the local setup for contributors accordingly
I'm also updating the code blocks guide:
Before:
After:
