Docs troubleshooting page #8312
Conversation
|
@Bonapara could you take a look? It's a WIP as I'm starting to check issues and gather all information |
![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 consolidates troubleshooting documentation from various sources into a dedicated page and makes minor text improvements across the documentation for better clarity and accuracy.
- Added new
/packages/twenty-website/src/content/developers/self-hosting/troubleshooting.mdxwith common solutions from Discord help channels - Moved troubleshooting sections from
local-setup.mdxanddocker-compose.mdxto the new dedicated page - Fixed file extension references in
import-export-data.mdxfrom.xslx/.xslto.xlsx/.xls - Corrected command examples in
README.mdto consistently usenpx nxinstead of justnx - Removed erroneous line "Sure, here is the glossary..." from
glossary.mdx
11 file(s) reviewed, 7 comment(s)
Edit PR Review Bot Settings | Greptile
packages/twenty-website/src/content/developers/self-hosting/docker-compose.mdx
Show resolved
Hide resolved
packages/twenty-website/src/content/developers/self-hosting/docker-compose.mdx
Show resolved
Hide resolved
packages/twenty-website/src/content/developers/self-hosting/troubleshooting.mdx
Show resolved
Hide resolved
packages/twenty-website/src/content/developers/self-hosting/troubleshooting.mdx
Show resolved
Hide resolved
packages/twenty-website/src/content/developers/self-hosting/troubleshooting.mdx
Outdated
Show resolved
Hide resolved
|
Looking good to me! I just can't remember if the docs supports H4 (####) did you check? |
|
From what I checked, H4 is supported like here |
|
@Bonapara I checked issues from #help channel from last 6 months, didn't see anything special which could be added as most problems are outdated by now, if you think solutions for old problems should be added, let me know |
There was a problem hiding this comment.
PR Summary
(updates since last review)
Based on the recent changes, I'll provide a summary focusing only on the new modifications not covered in the previous review:
This PR continues to improve documentation clarity and organization with minor but important text corrections across multiple files.
- Added new
/packages/twenty-website/src/content/developers/self-hosting/qa.mdxto address common user questions about integrations, account recovery, and hosting options - Updated version-specific URLs in
docker-compose.mdxto point to v0.32.0 instead of main branch for better stability - Added detailed configuration instructions for external access in
docker-compose.mdx - Documented Redis connection and JWT token handling changes for v0.32.0 in
upgrade-guide.mdx
11 file(s) reviewed, 7 comment(s)
Edit PR Review Bot Settings | Greptile
| @@ -45,7 +44,7 @@ Follow these steps for a manual setup. | |||
|
|
|||
| Copy the example environment file to a new .env file in your working directory: | |||
| ```bash | |||
| curl -o .env https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-docker/.env.example | |||
| curl -o .env https://raw.githubusercontent.com/twentyhq/twenty/refs/tags/v0.32.0/packages/twenty-server/.env.example | |||
There was a problem hiding this comment.
logic: URL path should be twenty-docker/.env.example not twenty-server/.env.example
There was a problem hiding this comment.
I don't like the way link in docker-compose page is presented with tag as it forces to update page every release but this secures from tickets about wrong configuration when changes in environment variables are pushed to repo during sprint, how should it be solved?
packages/twenty-website/src/content/developers/self-hosting/qa.mdx
Outdated
Show resolved
Hide resolved
| 1. **Verify SERVER_URL:** | ||
|
|
||
| Ensure `SERVER_URL` in your `.env` file matches your external access URL, including `https` if SSL is enabled. |
There was a problem hiding this comment.
style: Add example of correct SERVER_URL format
| - Confirm that your reverse proxy is correctly forwarding requests to the Twenty server. | ||
| - Ensure headers like `X-Forwarded-For` and `X-Forwarded-Proto` are properly set. |
There was a problem hiding this comment.
style: Add example nginx/apache configuration for proper header forwarding
| @@ -121,7 +121,9 @@ We have updated the way we handle the Redis connection. | |||
|
|
|||
| Update your `.env` file to use the new `REDIS_URL` variable instead of the individual Redis connection parameters. | |||
|
|
|||
| We have also simplifed the way we handle the JWT tokens. | |||
| <ArticleEditContent></ArticleEditContent> | |||
There was a problem hiding this comment.
style: Empty ArticleEditContent tag appears to serve no purpose here and breaks the flow of the documentation.
Related to #8296