root/gpustack-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: add TODO: Translate me in locales

Browse Source
This commit is contained in:
jialin
2025-03-04 18:50:34 +08:00
parent 9b6112d206
commit f3bdb03cae
3 changed files with 44 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/locales/README.md
+32 -20
View File
@@ -2,30 +2,42 @@
To add a new language configuration, follow these steps:
1. **Duplicate an Existing Language Directory**
## 1. **Duplicate an Existing Language Directory**
- Choose any existing language directory that you are familiar with, and duplicate it.
- Name the new directory according to the `lang` attribute specified in `lang-config-map.tsx`.
- Choose any existing language directory that you are familiar with, and duplicate it.
- Name the new directory according to the `lang` attribute specified in `lang-config-map.tsx`.
2. **Create a New `.ts` File in the Current Directory**
## 2. **Create a New `.ts` File in the Current Directory**
- In the `locales` directory, create a `.ts` file named to align with the new directory.
- Copy the contents of the `en-US.ts` file into this new `.ts` file.
- Update the following line to match your new language directory:
```ts
const requireContext = require.context(
`./{new-language-directory}`,
false,
/\.ts$/
);
```
- In the `locales` directory, create a `.ts` file named to align with the new directory.
- Copy the contents of the `en-US.ts` file into this new `.ts` file.
- Update the following line to match your new language directory:
```ts
const requireContext = require.context(
`./{new-language-directory}`,
false,
/\.ts$/
);
```
3. **Translate Each Attribute Value**
## 3. **Translate Each Attribute Value**
- Open the `.ts` file in the **new directory**.
- Translate the value of each key into your target language.
- Open the `.ts` file in the **new directory**.
- For each key-value pair:
- If a translation is available, replace the value with the translated text.
- If no translation is available yet, **replace the value with** `"TODO: Translate me"`.
4. **Finalize the Configuration**
**Example:**
- Review and ensure all translations are complete.
- Your new language configuration is now ready for use!
```ts
export default {
welcome_message: 'TODO: Translate me',
logout_button: 'TODO: Translate me'
};
```
## 4. **Finalize the Configuration**
- Review and ensure all translations are complete.
- If any translations are missing, contributors can later replace `"TODO: Translate me"` with the correct translation.
- Your new language configuration is now ready for use!