diff --git a/contributing-guide.mdx b/contributing-guide.mdx index d22828b1..a104a1ee 100644 --- a/contributing-guide.mdx +++ b/contributing-guide.mdx @@ -39,7 +39,7 @@ We use git-flow branching model. The base branch is `develop`. Please raise your - Please make sure that you have read the [issue triage guidelines](https://www.chatwoot.com/hc/handbook/articles/issue-triage-29) before you make a contribution. - It's okay and encouraged to have multiple small commits as you work on the PR - we will squash the commits before merging. - For other guidelines, see [PR Guidelines](https://www.chatwoot.com/hc/handbook/articles/pull-request-guidelines-32) -- Ensure that all the text copies that you add into the product are i18n translatable. You are only required to add the `English` version of the strings. We pull in other language translations from our contributors on crowdin. See [Translation guidelines](https://www.chatwoot.com/docs/contributing-guide/translation-guidelines) to learn more. +- Ensure that all the text copies that you add into the product are i18n translatable. You are only required to add the `English` version of the strings. We pull in other language translations from our contributors on crowdin. See [Translation guidelines](/contributing-guide/translation-guidelines) to learn more. ## Development Workflow @@ -155,7 +155,7 @@ npm run cypress:open - Keep documentation clear and concise - Include code examples where helpful - Update documentation when changing functionality -- Follow our [translation guidelines](https://developers.chatwoot.com/contributing-guide/translation-guidelines) +- Follow our [translation guidelines](/contributing-guide/translation-guidelines) ### Internationalization - All user-facing text must be translatable @@ -166,21 +166,21 @@ npm run cypress:open We strive to maintain a welcoming and inclusive community: -- **[Code of Conduct](https://developers.chatwoot.com/contributing-guide/code-of-conduct)** - Our community standards -- **[Community Guidelines](https://developers.chatwoot.com/contributing-guide/community-guidelines)** - How we interact -- **[Security Reports](https://developers.chatwoot.com/contributing-guide/security-reports)** - Reporting security issues +- **[Code of Conduct](/contributing-guide/code-of-conduct)** - Our community standards +- **[Community Guidelines](/contributing-guide/community-guidelines)** - How we interact +- **[Security Reports](/contributing-guide/security-reports)** - Reporting security issues ## API Development If you're working on API-related features: -- **[Chatwoot APIs](https://developers.chatwoot.com/contributing-guide/chatwoot-apis)** - API development guide -- **[API Documentation](https://developers.chatwoot.com/contributing-guide/api-documentation)** - Documenting APIs -- **[Platform APIs](https://developers.chatwoot.com/contributing-guide/chatwoot-platform-apis)** - Platform-level APIs +- **[Chatwoot APIs](/contributing-guide/chatwoot-apis)** - API development guide +- **[API Documentation](/contributing-guide/api-documentation)** - Documenting APIs +- **[Platform APIs](/contributing-guide/chatwoot-platform-apis)** - Platform-level APIs ## Recognition -We value all contributions to Chatwoot. Check out our [Contributors page](https://developers.chatwoot.com/contributing-guide/contributors) to see the amazing people who have helped make Chatwoot better. +We value all contributions to Chatwoot. Check out our [Contributors page](/contributing-guide/contributors) to see the amazing people who have helped make Chatwoot better. ## Getting Help diff --git a/self-hosted/configuration/features/email-channel/conversation-continuity-using-sendgrid.mdx b/self-hosted/configuration/features/email-channel/conversation-continuity-using-sendgrid.mdx index 5510a287..c6dbfdb6 100644 --- a/self-hosted/configuration/features/email-channel/conversation-continuity-using-sendgrid.mdx +++ b/self-hosted/configuration/features/email-channel/conversation-continuity-using-sendgrid.mdx @@ -4,11 +4,11 @@ description: Guide to setting up Conversation Continuity with SendGrid sidebarTitle: SendGrid Ingress --- -This doc will help you set up [Conversation continuity](https://www.chatwoot.com/docs/self-hosted/configuration/features/email-channel/conversation-continuity) with SendGrid. +This doc will help you set up [Conversation continuity](/self-hosted/configuration/features/email-channel/conversation-continuity) with SendGrid. ## Installation -This example is based on a Heroku installation of Chatwoot, and using SendGrid for outgoing email. For more information about installing Chatwoot, go [here](https://www.chatwoot.com/docs/self-hosted#deployment). +This example is based on a Heroku installation of Chatwoot, and using SendGrid for outgoing email. For more information about installing Chatwoot, go [here](/self-hosted). ## Configuring inbound reply emails @@ -80,4 +80,4 @@ You should change ``support.example.com`` to the domain you used with SendGrid. ## Next steps -You're done! Next, you should [enable the email channel](https://developers.chatwoot.com/self-hosted/configuration/features/email-channel/). +You're done! Next, you should [enable the email channel](/self-hosted/configuration/features/email-channel/introduction). diff --git a/self-hosted/deployment/aws.mdx b/self-hosted/deployment/aws.mdx index cb6c7dd9..6aefb793 100644 --- a/self-hosted/deployment/aws.mdx +++ b/self-hosted/deployment/aws.mdx @@ -234,7 +234,7 @@ vi .env RAILS_ENV=production bundle exec rake db:prepare ``` -13. Also modify the other necessary environment variable for your chatwoot setup. Refer to https://www.chatwoot.com/docs/self-hosted/deployment/linux-vm#configure-the-required-environment-variables +13. Also modify the other necessary environment variable for your chatwoot setup. Refer to the [Linux VM environment configuration guide](/self-hosted/deployment/linux-vm#configure-the-required-environment-variables). 14. Restart the `chatwoot` service. @@ -265,13 +265,13 @@ sudo cwctl --restart ## Monitoring -1. Refer to https://www.chatwoot.com/docs/self-hosted/monitoring/apm-and-error-monitoring +1. Refer to the [APM and error monitoring guide](/self-hosted/monitoring/apm-and-error-monitoring). ## Updating Chatwoot -1. log in to one of the application servers and complete the update instructions. Run migrations if needed. Refer to https://www.chatwoot.com/docs/self-hosted/deployment/linux-vm#upgrading-to-a-newer-version-of-chatwoot +1. Log in to one of the application servers and complete the update instructions. Run migrations if needed. Refer to the [Linux VM upgrade guide](/self-hosted/deployment/linux-vm#upgrading-to-a-newer-version-of-chatwoot). 2. Create a new ami and update the launch config. ## Conclusion -This document is a reference guideline for an HA chatwoot architecture on AWS. Modify or build upon this to suit your requirements. \ No newline at end of file +This document is a reference guideline for an HA chatwoot architecture on AWS. Modify or build upon this to suit your requirements. diff --git a/self-hosted/deployment/azure.mdx b/self-hosted/deployment/azure.mdx index ddf56b58..b5a85316 100644 --- a/self-hosted/deployment/azure.mdx +++ b/self-hosted/deployment/azure.mdx @@ -28,7 +28,7 @@ This guide is a work in progress and your mileage may vary. ## Install Chatwoot 1. SSH into the instance created from your local machine or create a bastion in azure to ssh via the browser. -2. Follow the linux VM instructions at https://www.chatwoot.com/docs/self-hosted/deployment/linux-vm. +2. Follow the [Linux VM instructions](/self-hosted/deployment/linux-vm). 3. Woot! Woot! Your Chatwoot Instance is ready and can be accessed at `http://:3000`. Or if you completed the domain setup during the installation, chatwoot should be available at `https://`. @@ -38,4 +38,4 @@ Browser access via port 3000 will only work if enabled under inbound rules. ## Configure Chatwoot 1. Follow the Chatwoot docs to configure your domain, email and other parameters you need. -https://www.chatwoot.com/docs/self-hosted/deployment/linux-vm#configure-the-required-environment-variables \ No newline at end of file +Refer to the [Linux VM environment configuration guide](/self-hosted/deployment/linux-vm#configure-the-required-environment-variables). diff --git a/self-hosted/deployment/digitalocean.mdx b/self-hosted/deployment/digitalocean.mdx index 818111fc..471647bd 100644 --- a/self-hosted/deployment/digitalocean.mdx +++ b/self-hosted/deployment/digitalocean.mdx @@ -22,10 +22,10 @@ our [1-click k8s app on DigitalOcean Marketplace](https://marketplace.digitaloce ## Install Chatwoot 1. SSH into the droplet created above. -2. Follow the linux VM instructions at https://www.chatwoot.com/docs/self-hosted/deployment/linux-vm. +2. Follow the [Linux VM instructions](/self-hosted/deployment/linux-vm). 3. Woot! Woot! Your Chatwoot Instance is ready and can be accessed at `http://:3000`. Or if you completed the domain setup during the installation, chatwoot should be available at `https://` ## Configure Chatwoot 1. Follow the Chatwoot docs to configure your domain, email and other parameters you need. -https://www.chatwoot.com/docs/self-hosted/deployment/linux-vm#configure-the-required-environment-variables \ No newline at end of file +Refer to the [Linux VM environment configuration guide](/self-hosted/deployment/linux-vm#configure-the-required-environment-variables). diff --git a/self-hosted/deployment/gcp.mdx b/self-hosted/deployment/gcp.mdx index 8806d03a..4d3ad27b 100644 --- a/self-hosted/deployment/gcp.mdx +++ b/self-hosted/deployment/gcp.mdx @@ -23,10 +23,10 @@ This guide is a work in progress and your mileage may vary. ## Install Chatwoot 1. SSH into the instance created. -2. Follow the linux VM instructions at https://www.chatwoot.com/docs/self-hosted/deployment/linux-vm. +2. Follow the [Linux VM instructions](/self-hosted/deployment/linux-vm). 3. Woot! Woot! Your Chatwoot Instance is ready and can be accessed at `http://:3000`. Or if you completed the domain setup during the installation, chatwoot should be available at `https://` ## Configure Chatwoot 1. Follow the Chatwoot docs to configure your domain, email and other parameters you need. -https://www.chatwoot.com/docs/self-hosted/deployment/linux-vm#configure-the-required-environment-variables \ No newline at end of file +Refer to the [Linux VM environment configuration guide](/self-hosted/deployment/linux-vm#configure-the-required-environment-variables). diff --git a/self-hosted/deployment/helm-chart.mdx b/self-hosted/deployment/helm-chart.mdx index eb0d80e1..ac40b936 100644 --- a/self-hosted/deployment/helm-chart.mdx +++ b/self-hosted/deployment/helm-chart.mdx @@ -138,7 +138,7 @@ Persistent volumes are not deleted automatically. They need to be removed manual | `env.AWS_ACCESS_KEY_ID` | Amazon access key ID | `""` | | `env.AWS_REGION` | Amazon region | `""` | | `env.AWS_SECRET_ACCESS_KEY` | Amazon secret key ID | `""` | -| `env.FB_APP_ID` | For facebook channel https://www.chatwoot.com/docs/facebook-setup | `""` | +| `env.FB_APP_ID` | For facebook channel, see [Facebook setup](/self-hosted/configuration/features/integrations/facebook-channel-setup) | `""` | | `env.FB_APP_SECRET` | For facebook channel | `""` | | `env.FB_VERIFY_TOKEN` | For facebook channel | `""` | | `env.SLACK_CLIENT_ID` | For slack integration | `""` | @@ -231,4 +231,4 @@ Make sure the "Persistent Volume Claims" can be satisfied. Refer to [prerequisit ActionController::InvalidAuthenticityToken HTTP Origin header (https://mydomain.com) didn't match request.base_url (http://mydomain.com) ``` -If you are recieving the above error when trying to access the superadmin panel, configure your ingress controller to forward the protocol of the origin request. For `nginx` ingress, you can do this by setting the `proxy_set_header X-Forwarded-Proto https;` config. Refer this [issue](https://github.com/chatwoot/chatwoot/issues/5506) to learn more. \ No newline at end of file +If you are recieving the above error when trying to access the superadmin panel, configure your ingress controller to forward the protocol of the origin request. For `nginx` ingress, you can do this by setting the `proxy_set_header X-Forwarded-Proto https;` config. Refer this [issue](https://github.com/chatwoot/chatwoot/issues/5506) to learn more. diff --git a/self-hosted/runbooks/upgrade-to-chatwoot-v4.mdx b/self-hosted/runbooks/upgrade-to-chatwoot-v4.mdx index 38984cf6..2c9ff215 100644 --- a/self-hosted/runbooks/upgrade-to-chatwoot-v4.mdx +++ b/self-hosted/runbooks/upgrade-to-chatwoot-v4.mdx @@ -98,7 +98,7 @@ sudo apt install postgresql-16-pgvector ``` 2. After verifying that the existing installation works with the pgvector image, proceed with the regular upgrade steps. - [Learn more](https://www.chatwoot.com/docs/self-hosted/deployment/upgrade#docker) + [Learn more](/self-hosted/deployment/upgrade#docker) ### Kubernetes (Helm Chart) @@ -122,4 +122,4 @@ If you use the built-in PostgreSQL via the official Helm chart, follow the steps repository: chatwoot/pgvector ``` -2. Run `helm upgrade` with this custom values.yaml file. \ No newline at end of file +2. Run `helm upgrade` with this custom values.yaml file.