mirror of
https://github.com/remnawave/panel.git
synced 2026-04-26 09:48:50 +00:00
Improve docs grammar (#109)
* Improve docs grammar * Update docs/features/oauth2-configuration.md Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> --------- Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
This commit is contained in:
Amir2012
@@ -5,7 +5,7 @@ title: Localization
|
||||
|
||||
Remnawave is available in multiple languages. We use [Crowdin](https://i18n.remna.st) to manage translations.
|
||||
|
||||
Currenly, we have languages available:
|
||||
Currenly the following languages are available:
|
||||
|
||||
- English
|
||||
- Chinese
|
||||
@@ -14,44 +14,44 @@ Currenly, we have languages available:
|
||||
|
||||
:::warning
|
||||
|
||||
Please don't push direcly locale files to the repository.
|
||||
Please do not directly modify localization files in pull requests - they are meant to be edited only using Crowdin.
|
||||
|
||||
:::
|
||||
|
||||
## How to contribute
|
||||
|
||||
Firsly, join our group on Telegram: [Join link](https://t.me/+cAFRGkqSWJcxNjE6).
|
||||
First of all you need to join our Telegram group: [Join link](https://t.me/+cAFRGkqSWJcxNjE6).
|
||||
|
||||
Ping admins in the group and ask them to add you to the project.
|
||||
|
||||
Most likely, you will need a valid email address to join the project. One of maintainers will invite to Crowdin.
|
||||
You will need a Crowdin account with a valid email address to join the project. One of the maintainers will invite you to the Crowdin team.
|
||||
|
||||
After that, you can start translating the text.
|
||||
After that you can start translating the text.
|
||||
|
||||
## How to translate
|
||||
|
||||
Basically, you have two options. Lets take a loot for both.
|
||||
There are two options when it comes to making translations. Lets take a look at both.
|
||||
|
||||
### Option 1: Translate in the Crowdin
|
||||
### Option 1: Translate in the Crowdin website
|
||||
|
||||
This is the most simple way to translate the text, you don't need the running Remnawave instance.
|
||||
This is the simplest way to translate the text - you don't even need a running Remnawave instance.
|
||||
|
||||
1. Go to [Crowdin](https://i18n.remna.st) and login/create account with your email.
|
||||
2. Select the language you want to translate.
|
||||
1. Go to [Crowdin](https://i18n.remna.st) and login/create an account with your email address.
|
||||
2. Select your target language.
|
||||
3. Translate the text.
|
||||
4. Click "Save" button.
|
||||
4. Click the "Save" button.
|
||||
5. Wait for the translation to be approved.
|
||||
6. The translation will be automatically deployed to the dev-branch after approval.
|
||||
6. Approved translations will be automatically deployed to the dev-branch.
|
||||
|
||||
<img src={require('/contributing/i18n/i18n_1.webp').default} width="100%" style={{borderRadius: '8px'}} alt="First steps" />
|
||||
|
||||
### Option 2: In-Context Translation
|
||||
|
||||
This setup can be a bit tricky.
|
||||
This one can be a little bit tricky.
|
||||
|
||||
You need running Remnawave with dev-branch.
|
||||
You are going to need a running Remnawave dev-branch instance.
|
||||
|
||||
First, make sure you have dev branch image.
|
||||
Check your docker-compose file to make sure you are using the dev branch image.
|
||||
|
||||
```yaml title="docker-compose.yml"
|
||||
remnawave:
|
||||
@@ -73,7 +73,7 @@ First, make sure you have dev branch image.
|
||||
condition: service_healthy
|
||||
```
|
||||
|
||||
Edit `.env` file and the following line:
|
||||
Edit the `.env` file and add the following line:
|
||||
|
||||
```bash title=".env"
|
||||
IS_CROWDIN_EDITOR_ENABLED=true
|
||||
@@ -81,58 +81,58 @@ IS_CROWDIN_EDITOR_ENABLED=true
|
||||
|
||||
:::warning
|
||||
|
||||
Before translating, make sure you have latest dev image, pull before running.
|
||||
Before you start translating run "docker pull" to make sure you have the latest dev image.
|
||||
|
||||
:::
|
||||
|
||||
:::danger
|
||||
|
||||
This .env variable will work only for the dev-branch. On stable branch it does nothing.
|
||||
This .env variable will work only with the dev-branch and it has no effect on the stable branch instances.
|
||||
:::
|
||||
|
||||
Restart Remnawave container.
|
||||
Restart the Remnawave container.
|
||||
|
||||
```bash
|
||||
docker compose down && docker compose up -d && docker compose logs -f -t
|
||||
```
|
||||
|
||||
Now, open panel in your browser and you will see this:
|
||||
Now open the panel in your browser and you will see something like this:
|
||||
|
||||
<img src={require('/contributing/i18n/i18n_2.webp').default} width="100%" style={{borderRadius: '8px'}} alt="First steps" />
|
||||
|
||||
Select language you want to translate and login to your Crowdin account, you will be redirected back to the panel.
|
||||
Select the language you want to translate into and login to your Crowdin account. You will be redirected back to the panel.
|
||||
|
||||
<img src={require('/contributing/i18n/i18n_4.webp').default} width="100%" style={{borderRadius: '8px'}} alt="First steps" />
|
||||
|
||||
You can encounter this modal warning, skip it for now.
|
||||
You might encounter this warning, skip it for now.
|
||||
|
||||
Login to Remnawave dashboard, and check language switcher – select **Crowdin** language.
|
||||
Login to Remnawave dashboard and in the language switcher select **Crowdin**.
|
||||
|
||||
<img src={require('/contributing/i18n/i18n_5.webp').default} width="100%" style={{borderRadius: '8px'}} alt="First steps" />
|
||||
|
||||
Now, you can translate the text in the browser.
|
||||
Now you can translate the text in the comfort of your browser.
|
||||
|
||||
<img src={require('/contributing/i18n/i18n_6.webp').default} width="100%" style={{borderRadius: '8px'}} alt="First steps" />
|
||||
|
||||
You can see borders on translated/untraslated text, click on it to edit.
|
||||
You can see borders on translated/untranslated text, click on it to edit.
|
||||
|
||||
<img src={require('/contributing/i18n/i18n_7.webp').default} width="100%" style={{borderRadius: '8px'}} alt="First steps" />
|
||||
|
||||
Don't forget to click **Save** button to save you translated text.
|
||||
Don't forget to click **Save** to save your translations.
|
||||
|
||||
## Issues
|
||||
|
||||
### Infinite loading
|
||||
### Infinite loading screen
|
||||
|
||||
<img src={require('/contributing/i18n/i18n_3.webp').default} width="100%" style={{borderRadius: '8px'}} alt="First steps" />
|
||||
|
||||
Sometines you can encounter infinite loading of Crowdin iframe, it looks like in the image above.
|
||||
Sometimes you might encounter an infinite loading screen in the Crowdin iframe, as depicted above.
|
||||
|
||||
Currently, there is no guaranted way to fix this.
|
||||
Currently there is no sure-fire way to fix this.
|
||||
|
||||
Possible workarounds:
|
||||
|
||||
- Try to use clear Chrome browser without any extensions.
|
||||
- Try to reload page 5-10 times
|
||||
- Try to open panel in new tab (a few times)
|
||||
- Open Devtools (F12), navigate to Network tab and activate "Disable cache" checkbox, then reload page multiple times
|
||||
- Try using a vanilla Chrome browser without any extensions
|
||||
- Try to reload the page 5-10 times
|
||||
- Try to open the panel in a new tab (a few times)
|
||||
- Open Devtools (F12), navigate to the Network tab and check "Disable cache", then reload the page a couple of times
|
||||
|
||||
Reference in New Issue
Block a user