Skip to content

Commit

Permalink
i18n: use zh-TW and zh-CN over zh-Hant and zh-Hans (#377)
Browse files Browse the repository at this point in the history
Both crowdin and docsearch i18n configs use TW and CN over Hant and Hans. This should reduce some config confusions.
cc @ericnakagawa. Also, apparently you're working on algolia search i18n?
  • Loading branch information
chenglou authored and JoelMarcey committed Jan 11, 2018
1 parent c08142c commit 00270c2
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 17 deletions.
4 changes: 2 additions & 2 deletions crowdin.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ files:
'tr': 'tr'
'uk': 'uk'
'vi': 'vi'
'zh-CN': 'zh-Hans'
'zh-TW': 'zh-Hant'
'zh-CN': 'zh-CN'
'zh-TW': 'zh-TW'
-
source: '/website/i18n/en.json'
translation: '/website/i18n/%locale%.json'
Expand Down
12 changes: 6 additions & 6 deletions docs/guides-translation.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The `pages/en/help-with-translations.js` file includes the same starter help pag

The `languages.js` file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

The `crowdin.yaml` file is used to configure crowdin integration, and is copied up one level into your docusaurus project repo. If your docusaurus project resides in `/project/website`, then `crowdin.yaml` will be copied to `/project/crowdin.yaml`.
The `crowdin.yaml` file is used to configure crowdin integration, and is copied up one level into your docusaurus project repo. If your docusaurus project resides in `/project/website`, then `crowdin.yaml` will be copied to `/project/crowdin.yaml`.

## Translating Your Existing Docs

Expand Down Expand Up @@ -140,8 +140,8 @@ files:
'ko': 'ko'
'mr': 'mr-IN'
'pt-BR': 'pt-BR'
'zh-CN': 'zh-Hans'
'zh-TW': 'zh-Hant'
'zh-CN': 'zh-CN'
'zh-TW': 'zh-TW'
```
You can go [here](https://support.crowdin.com/configuration-file/) to learn more about customizing your `crowdin.yaml` file.
Expand All @@ -150,7 +150,7 @@ You can go [here](https://support.crowdin.com/configuration-file/) to learn more

You will want to manually sync your files to and from crowdin. The sync process will upload any markdown files in `/docs` as well as translatable strings in `website/i18n/en.json`. (These strings can be generated by running `yarn write-translations`.)

You can add the following to your `package.json` to manually trigger crowdin.
You can add the following to your `package.json` to manually trigger crowdin.

```json
"scripts": {
Expand Down Expand Up @@ -209,7 +209,7 @@ Note that in the `crowdin.yaml` file, `CROWDIN_PROJECT_ID` and `CROWDIN_API_KEY`

Now, Circle will help you automatically get translations prior to building your website. The provided `crowdin.yaml` file will copy translated documents into `website/translated_docs/`, and translated versions of the `i18n/en.json` strings file will into `i18n/${language}.json`.

If you wish to use Crowdin on your machine locally, you can install the [Crowdin CLI tool](https://support.crowdin.com/cli-tool/) and run the same commands found in the `circle.yaml` file. The only difference is that you must set `project_identifier` and `api_key` values in the `crowdin.yaml` file since you will not have Circle environment variables set up.
If you wish to use Crowdin on your machine locally, you can install the [Crowdin CLI tool](https://support.crowdin.com/cli-tool/) and run the same commands found in the `circle.yaml` file. The only difference is that you must set `project_identifier` and `api_key` values in the `crowdin.yaml` file since you will not have Circle environment variables set up.

## Versioned Translations

Expand All @@ -224,4 +224,4 @@ If you wish to have translation and versioning for your documentation, add the f

Translated, versioned documents will be copied into `website/translated_docs/${language}/${version}/`.

> Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to ["Hide - all duplicates will share the same translation"](https://support.crowdin.com/api/create-project/). This setting will ensure that identical strings between versions share a single translation.
> Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to ["Hide - all duplicates will share the same translation"](https://support.crowdin.com/api/create-project/). This setting will ensure that identical strings between versions share a single translation.
4 changes: 2 additions & 2 deletions examples/translations/crowdin.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ files:
'tr': 'tr'
'uk': 'uk'
'vi': 'vi'
'zh-CN': 'zh-Hans'
'zh-TW': 'zh-Hant'
'zh-CN': 'zh-CN'
'zh-TW': 'zh-TW'
-
source: '/website/i18n/en.json'
translation: '/website/i18n/%locale%.json'
Expand Down
4 changes: 2 additions & 2 deletions examples/translations/languages.js
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,8 @@ const languages = [
{
enabled: false,
name: '中文',
tag: 'zh-Hans',
tag: 'zh-CN',
},
{enabled: false, name: '繁體中文', tag: 'zh-Hant'},
{enabled: false, name: '繁體中文', tag: 'zh-TW'},
];
module.exports = languages;
10 changes: 5 additions & 5 deletions website/languages.js
Original file line number Diff line number Diff line change
Expand Up @@ -174,12 +174,12 @@ const languages = [
{
enabled: false,
name: "简体中文",
tag: "zh-Hans"
tag: "zh-CN"
},
{
enabled: false,
name: "繁體中文",
tag: "zh-Hant"
{
enabled: false,
name: "繁體中文",
tag: "zh-TW"
}
];
module.exports = languages;

0 comments on commit 00270c2

Please sign in to comment.