Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions contributing-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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](https://developers.chatwoot.com/contributing-guide/translation-guidelines) to learn more.

## Development Workflow

Expand Down Expand Up @@ -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://www.chatwoot.com/docs/contributing-guide/other/translation-guidelines)
- Follow our [translation guidelines](https://developers.chatwoot.com/contributing-guide/translation-guidelines)

### Internationalization
- All user-facing text must be translatable
Expand All @@ -166,21 +166,21 @@ npm run cypress:open

We strive to maintain a welcoming and inclusive community:

- **[Code of Conduct](https://www.chatwoot.com/docs/contributing-guide/other/code-of-conduct)** - Our community standards
- **[Community Guidelines](https://www.chatwoot.com/docs/contributing-guide/other/community-guidelines)** - How we interact
- **[Security Reports](https://www.chatwoot.com/docs/contributing-guide/other/security-reports)** - Reporting security issues
- **[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

## API Development

If you're working on API-related features:

- **[Chatwoot APIs](https://www.chatwoot.com/docs/contributing-guide/other/chatwoot-apis)** - API development guide
- **[API Documentation](https://www.chatwoot.com/docs/contributing-guide/other/api-documentation)** - Documenting APIs
- **[Platform APIs](https://www.chatwoot.com/docs/contributing-guide/other/chatwoot-platform-apis)** - Platform-level APIs
- **[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

## Recognition

We value all contributions to Chatwoot. Check out our [Contributors page](https://www.chatwoot.com/docs/contributing-guide/other/contributors) to see the amazing people who have helped make Chatwoot better.
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.

## Getting Help

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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](https://developers.chatwoot.com/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](https://developers.chatwoot.com/self-hosted).

## Configuring inbound reply emails

Expand Down Expand Up @@ -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://www.chatwoot.com/docs/self-hosted/configuration/features/email-channel/setup).
You're done! Next, you should [enable the email channel](https://developers.chatwoot.com/self-hosted/configuration/features/email-channel/introduction).
6 changes: 3 additions & 3 deletions self-hosted/deployment/aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 https://developers.chatwoot.com/self-hosted/deployment/linux-vm#configure-the-required-environment-variables

14. Restart the `chatwoot` service.

Expand Down Expand Up @@ -265,11 +265,11 @@ sudo cwctl --restart

## Monitoring

1. Refer to https://www.chatwoot.com/docs/self-hosted/monitoring/apm-and-error-monitoring
1. Refer to https://developers.chatwoot.com/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 https://developers.chatwoot.com/self-hosted/deployment/linux-vm#upgrading-to-a-newer-version-of-chatwoot
2. Create a new ami and update the launch config.

## Conclusion
Expand Down
4 changes: 2 additions & 2 deletions self-hosted/deployment/azure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 at https://developers.chatwoot.com/self-hosted/deployment/linux-vm.
3. Woot! Woot! Your Chatwoot Instance is ready and can be accessed at `http://<your-instance-ip>:3000`. Or if you completed the domain setup during the installation, chatwoot should be available at `https://<your-domain>`.

<Note>
Expand All @@ -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
https://developers.chatwoot.com/self-hosted/deployment/linux-vm#configure-the-required-environment-variables
4 changes: 2 additions & 2 deletions self-hosted/deployment/digitalocean.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 at https://developers.chatwoot.com/self-hosted/deployment/linux-vm.
3. Woot! Woot! Your Chatwoot Instance is ready and can be accessed at `http://<your-droplet-ip>:3000`. Or if you completed the domain setup during the installation, chatwoot should be available at `https://<your-domain>`

## 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
https://developers.chatwoot.com/self-hosted/deployment/linux-vm#configure-the-required-environment-variables
4 changes: 2 additions & 2 deletions self-hosted/deployment/gcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 at https://developers.chatwoot.com/self-hosted/deployment/linux-vm.
3. Woot! Woot! Your Chatwoot Instance is ready and can be accessed at `http://<your-instance-ip>:3000`. Or if you completed the domain setup during the installation, chatwoot should be available at `https://<your-domain>`

## 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
https://developers.chatwoot.com/self-hosted/deployment/linux-vm#configure-the-required-environment-variables
2 changes: 1 addition & 1 deletion self-hosted/deployment/helm-chart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 https://developers.chatwoot.com/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 | `""` |
Expand Down
2 changes: 1 addition & 1 deletion self-hosted/runbooks/upgrade-to-chatwoot-v4.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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](https://developers.chatwoot.com/self-hosted/deployment/upgrade#docker)

### Kubernetes (Helm Chart)

Expand Down
Loading