Skip to content

Made changes to translation guidelines #538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
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
4 changes: 2 additions & 2 deletions docs/contributing-guide/api-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "API Documentation"
---

Chatwoot uses [Swagger 2.0](https://swagger.io/specification/v2/) for documenting the API.
Chatwoot uses [Swagger 2.0](https://swagger.io/specification/v2/) for documenting APIs.

### File/Directory structure

Expand All @@ -25,4 +25,4 @@ rake swagger:build

### Testing

In development mode, `http://localhost:3000/swagger` is available to test whether the API changes has been updated.
In development mode, `http://localhost:3000/swagger` is available to test whether the API changes are updated.
6 changes: 3 additions & 3 deletions docs/contributing-guide/chatwoot-platform-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ To create a platform app, follow these steps:

![Super Admin Portal](./images/platform-app/super_admin.png)

2. Click on the "New platform app" button.
2. Click the "New platform app" button.

![Platform Apps Home](./images/platform-app/platform-home.png)

3. Fill in the platform app name and click the "Create" button.
3. Enter the platform app name and click **Create Platform app**.

![Create Platform App](./images/platform-app/platform-create.png)

Expand All @@ -30,7 +30,7 @@ To create a platform app, follow these steps:

## Using the Access Token

The `access_token` is required to authenticate all API requests. Please use the Postman collection to test these APIs.
The `access_token` is required to authenticate all API requests. Use the Postman collection to test these APIs.

### Testing the APIs

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing-guide/common-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The following are some of the errors you might encounter while setting up the pr
ArgumentError: invalid uri scheme
```

This is an error thrown from redis connector. You might not have setup the redis environment variables properly. Please refer to dependencies section to install redis-server and [Configure Redis URL](https://www.chatwoot.com/docs/environment-variables) in the environment-variables section.
This is an error thrown from redis connector. You might not have setup the redis environment variables properly. Refer to dependencies section to install redis-server and [Configure Redis URL](https://www.chatwoot.com/docs/environment-variables) in the environment-variables section.


### pg gem Installation error
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing-guide/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: 'Environment variables'
---

For a complete set of production environment variables, please refer to [Production Environment Variables Guide](/docs/self-hosted/configuration/environment-variables)
For a complete set of production environment variables, Refer to [Production Environment Variables Guide](/docs/self-hosted/configuration/environment-variables)

In addition to the above variables, you can use the following variables in development mode.

Expand Down
10 changes: 5 additions & 5 deletions docs/contributing-guide/line-channel-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ sidebar_label: "Line App"
title: "Setup Line app integration on your local machine"
---

Please follow the steps if you are trying to work with the Line integration on your local machine.
To work with the Line integration on your local machine, do the following:

- Start a Ngrok server listening at port `3000` or the port you will be running the Chatwoot installation.
- Update the .env variable FRONTEND_URL in Chatwoot with the `https` version of the Ngrok URL.
- Start the Chatwoot server and create a new Line channel with the below values obtained from [Line Developer Console](https://developers.line.biz/console) under the "Messaging API" channel.

1. Channel Name
2. LINE Channel ID
3. LINE Channel Secret
4. LINE Channel Token
- Channel Name
- LINE Channel ID
- LINE Channel Secret
- LINE Channel Token

After creating the channel, Chatwoot will provide a webhook URL for the channel. You can configure this webhook url in the [Line Developer Console](https://developers.line.biz/console) under the "Messaging API" channel.

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing-guide/project-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_label: "Setup Guide"
title: "Project Setup"
---

This guide will help you to setup and run Chatwoot in development mode. Please make sure you have completed the environment setup.
This guide will help you to setup and run Chatwoot in development mode. Ensure you have completed the environment setup.

### Clone the repo

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing-guide/security-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you have any questions about the process, contact [email protected].

Please try your best to describe a clear and realistic impact for your report, and please don't open any public issues on GitHub or social media; we're doing our best to respond through Github as quickly as possible.

> Note: Please use the email for questions related to the process. Disclosures should be done via [Github](https://github.com/chatwoot/chatwoot/security/advisories/new).
> Note: Use the email for questions related to the process. Disclosures should be done via [Github](https://github.com/chatwoot/chatwoot/security/advisories/new).

## Supported versions

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing-guide/telegram-channel-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_label: "Telegram App"
title: "Setup Telegram app integration on your local machine"
---

Please follow the steps if you are trying to work with the Telegram integration on your local machine.
To work with the Telegram integration on your local machine, do the following:

- Start a Ngrok server listening at port `3000` or the port you will be running the Chatwoot installation.
- Update the .env variable FRONTEND_URL in Chatwoot with the `https` version of the Ngrok URL.
Expand Down
5 changes: 2 additions & 3 deletions docs/contributing-guide/translation-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ Chatwoot uses American English by default. Each and every string available in Ch

## How do I see the strings that needs to be translated?

In the codebase the string are placed in the following locations.

In the codebase, the string are placed in the following locations:
- `app/javascript/dashboard/i18n` - The strings related to the agent dashboard
- `app/javascript/widget/i18n` - The strings related to the web widget
- `app/javascript/survey/i18n` - The strings related to CSAT surveys
Expand All @@ -34,7 +33,7 @@ At Chatwoot, we prefer to use formal form of language wherever possible. For ins

Proofreading helps ensure the accuracy and consistency of translations. Right now, the translations are being accepted without a proof reading step. This would be changed in the future as an when there are more contributors on each language.

*Note:* If you are the only person contributing to a language, make sure that you inform any of the Chatwoot members to gain access to manage the language.
*Note:* If you are the only person contributing to a language, ensure that you inform any of the Chatwoot members to gain access to manage the language.

### Releasing a new language

Expand Down