Skip to content

Commit 188f7c9

Browse files
alexandrtovmachMaledongTrott
authored
docs: Actualized TRANSLATION guide (#3061)
* docs: Actualized TRANSLATION guide * fix: Formatted TRANSLATION.md; Fixed typo * Apply suggestions from Rich code review Co-Authored-By: Rich Trott <rtrott@gmail.com> * Update TRANSLATION.md Co-authored-by: Maledong <52018749+MaledongGit@users.noreply.github.com> Co-authored-by: Rich Trott <rtrott@gmail.com>
1 parent a6f9ed7 commit 188f7c9

1 file changed

Lines changed: 70 additions & 65 deletions

File tree

TRANSLATION.md

Lines changed: 70 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -4,68 +4,73 @@ Node.js is a global platform and so this site has many translations. The transla
44
languages other than English is handled by the localization working group of the language in question. If you
55
would like to contribute to the translation of nodejs.org, please refer to the following process:
66

7-
## For Individuals wanting to contribute
8-
9-
* Contact your appropriate localization group, and discuss with them the best possible way to contribute. A list of the localization groups can be found here (please keep in mind that some groups have not yet taken action upon the project name changes, hence the outdated repository names):
10-
11-
* [`nodejs-ar`](https://github.com/nodejs/nodejs-ar) Arabic Community
12-
* [`nodejs-bg`](https://github.com/nodejs/nodejs-bg) Bulgarian Community
13-
* [`nodejs-bn`](https://github.com/nodejs/nodejs-bn) Bengali Community
14-
* [`nodejs-zh-CN`](https://github.com/nodejs/nodejs-zh-CN) Chinese Community
15-
* [`nodejs-cs`](https://github.com/nodejs/nodejs-cs) Czech Community
16-
* [`nodejs-da`](https://github.com/nodejs/nodejs-da) Danish Community
17-
* [`nodejs-de`](https://github.com/nodejs/nodejs-de) German Community
18-
* [`nodejs-el`](https://github.com/nodejs/nodejs-el) Greek Community
19-
* [`nodejs-es`](https://github.com/nodejs/nodejs-es) Spanish Community
20-
* [`nodejs-fa`](https://github.com/nodejs/nodejs-fa) Persian Community
21-
* [`nodejs-fi`](https://github.com/nodejs/nodejs-fi) Finnish Community
22-
* [`nodejs-fr`](https://github.com/nodejs/nodejs-fr) French Community
23-
* [`nodejs-he`](https://github.com/nodejs/nodejs-he) Hebrew Community
24-
* [`nodejs-hi`](https://github.com/nodejs/nodejs-hi) Hindi Community
25-
* [`nodejs-hu`](https://github.com/nodejs/nodejs-hu) Hungarian Community
26-
* [`nodejs-id`](https://github.com/nodejs/nodejs-id) Indonesian Community
27-
* [`nodejs-it`](https://github.com/nodejs/nodejs-it) Italian Community
28-
* [`nodejs-ja`](https://github.com/nodejs/nodejs-ja) Japanese Community
29-
* [`nodejs-ka`](https://github.com/nodejs/nodejs-ka) Georgian Community
30-
* [`nodejs-ko`](https://github.com/nodejs/nodejs-ko) Korean Community
31-
* [`nodejs-mk`](https://github.com/nodejs/nodejs-mk) Macedonian Community
32-
* [`nodejs-ms`](https://github.com/nodejs/nodejs-ms) Malaysian Community
33-
* [`nodejs-nl`](https://github.com/nodejs/nodejs-nl) Dutch Community
34-
* [`nodejs-no`](https://github.com/nodejs/nodejs-no) Norwegian Community
35-
* [`nodejs-pl`](https://github.com/nodejs/nodejs-pl) Polish Community
36-
* [`nodejs-pt`](https://github.com/nodejs/nodejs-pt) Portuguese Community
37-
* [`nodejs-ro`](https://github.com/nodejs/nodejs-ro) Romanian Community
38-
* [`nodejs-ru`](https://github.com/nodejs/nodejs-ru) Russian Community
39-
* [`nodejs-sv`](https://github.com/nodejs/nodejs-sv) Swedish Community
40-
* [`nodejs-ta`](https://github.com/nodejs/nodejs-ta) Tamil Community
41-
* [`nodejs-tr`](https://github.com/nodejs/nodejs-tr) Turkish Community
42-
* [`nodejs-zh-TW`](https://github.com/nodejs/nodejs-zh-TW) Taiwanese Community
43-
* [`nodejs-uk`](https://github.com/nodejs/nodejs-uk) Ukrainian Community
44-
* [`nodejs-vi`](https://github.com/nodejs/nodejs-vi) Vietnamese Community
45-
46-
## For Localization Groups
47-
48-
* Ensure that any site translations are done as pull requests into the appropriate language folder in this repo. This will ensure the build process, layout, and styling, remain consistent across the different translations of the site.
49-
50-
* You can find the appropriate language folder within `locale/`. If not, create one matching the two-letter [ISO code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of your language. To specify a dialect for your language, [separate it with a dash](https://en.wikipedia.org/wiki/IETF_language_tag) (e.g. `pt-br` for Brazilian Portuguese, `zh-tw` for Taiwanese Mandarin).
51-
52-
* The following files need to be in your language folder:
53-
54-
* `site.json` (this contains the basic settings and navigation structure for the website)
55-
* `index.md` (this contains the Markdown translation for the home page.)
56-
* `styles.scss` (this imports the necessary Sass files)
57-
* All files and files in subfolders that end in `.md` are content pages and should be translated.
58-
59-
* Prefix your PR with the localization group's name (e.g. `nodejs-no`). If you are only translating one of the above files, please mention them in your PR's subject as well, e.g.:
60-
61-
```
62-
nodejs-de: Add files - index.md, faq.md
63-
nodejs-ro: Add files - 15 files
64-
65-
nodejs-fr: Update files - es6.md
66-
nodejs-ja: Update files - all files
67-
```
68-
69-
* Do not make language specific changes to layout or styling in a translation PR. If they are needed, make a separate styling/layout pr and talk with one of the website WG about the change. We want to make sure, for example, a Chinese layout change doesn't cascade failure to the German page.
70-
71-
* To be merged, translation PR's require a Website WG +1 and a +1 from another native speaker in your language. Make sure whoever you have review the PR adds a +1 in the comments of it so we know it is translated properly.
7+
> Since Apr, 1 2020 translation process moved to [Crowdin](https://crowdin.com/project/nodejs-website)
8+
9+
## Get started
10+
11+
1. Open [nodejs-website](https://crowdin.com/project/nodejs-website) Crowdin project
12+
2. Find your locale and start translation. Find more details in [guide for volunteer translators](https://support.crowdin.com/for-volunteer-translators/)
13+
14+
All translated and approved content will be pushed to this repo automatically. You don't need to create any PRs with translation. Just keep localization process on Crowdin.
15+
16+
Original source can be found in [/locale/en](https://github.com/nodejs/nodejs.org/tree/master/locale/en). If you find any problem with original source, please create a PR with changes directly to `/locale/en`. Crowdin automatically pull all updates within 24 hours.
17+
18+
### Can't find my locale on Crowdin
19+
20+
Please create a [new issue](https://github.com/nodejs/nodejs.org/issues/new?template=03-i18n.md) in this repo. Crowdin managers team would be happy to add new languages.
21+
22+
## Localization groups
23+
24+
An existing localization group is not required to start translation. You can contribute on Crowdin without it. Think about groups like a basement to communicate with other translators of your locale.
25+
26+
Contact your appropriate localization group, and discuss with them the best possible way to contribute. A list of the localization groups can be found below.
27+
28+
* [`nodejs-ar`](https://github.com/nodejs/nodejs-ar) Arabic Community
29+
* [`nodejs-bg`](https://github.com/nodejs/nodejs-bg) Bulgarian Community
30+
* [`nodejs-bn`](https://github.com/nodejs/nodejs-bn) Bengali Community
31+
* [`nodejs-zh-CN`](https://github.com/nodejs/nodejs-zh-CN) Chinese Community
32+
* [`nodejs-cs`](https://github.com/nodejs/nodejs-cs) Czech Community
33+
* [`nodejs-da`](https://github.com/nodejs/nodejs-da) Danish Community
34+
* [`nodejs-de`](https://github.com/nodejs/nodejs-de) German Community
35+
* [`nodejs-el`](https://github.com/nodejs/nodejs-el) Greek Community
36+
* [`nodejs-es`](https://github.com/nodejs/nodejs-es) Spanish Community
37+
* [`nodejs-fa`](https://github.com/nodejs/nodejs-fa) Persian Community
38+
* [`nodejs-fi`](https://github.com/nodejs/nodejs-fi) Finnish Community
39+
* [`nodejs-fr`](https://github.com/nodejs/nodejs-fr) French Community
40+
* [`nodejs-he`](https://github.com/nodejs/nodejs-he) Hebrew Community
41+
* [`nodejs-hi`](https://github.com/nodejs/nodejs-hi) Hindi Community
42+
* [`nodejs-hu`](https://github.com/nodejs/nodejs-hu) Hungarian Community
43+
* [`nodejs-id`](https://github.com/nodejs/nodejs-id) Indonesian Community
44+
* [`nodejs-it`](https://github.com/nodejs/nodejs-it) Italian Community
45+
* [`nodejs-ja`](https://github.com/nodejs/nodejs-ja) Japanese Community
46+
* [`nodejs-ka`](https://github.com/nodejs/nodejs-ka) Georgian Community
47+
* [`nodejs-ko`](https://github.com/nodejs/nodejs-ko) Korean Community
48+
* [`nodejs-mk`](https://github.com/nodejs/nodejs-mk) Macedonian Community
49+
* [`nodejs-ms`](https://github.com/nodejs/nodejs-ms) Malaysian Community
50+
* [`nodejs-nl`](https://github.com/nodejs/nodejs-nl) Dutch Community
51+
* [`nodejs-no`](https://github.com/nodejs/nodejs-no) Norwegian Community
52+
* [`nodejs-pl`](https://github.com/nodejs/nodejs-pl) Polish Community
53+
* [`nodejs-pt`](https://github.com/nodejs/nodejs-pt) Portuguese Community
54+
* [`nodejs-ro`](https://github.com/nodejs/nodejs-ro) Romanian Community
55+
* [`nodejs-ru`](https://github.com/nodejs/nodejs-ru) Russian Community
56+
* [`nodejs-sv`](https://github.com/nodejs/nodejs-sv) Swedish Community
57+
* [`nodejs-ta`](https://github.com/nodejs/nodejs-ta) Tamil Community
58+
* [`nodejs-tr`](https://github.com/nodejs/nodejs-tr) Turkish Community
59+
* [`nodejs-zh-TW`](https://github.com/nodejs/nodejs-zh-TW) Taiwanese Community
60+
* [`nodejs-uk`](https://github.com/nodejs/nodejs-uk) Ukrainian Community
61+
* [`nodejs-vi`](https://github.com/nodejs/nodejs-vi) Vietnamese Community
62+
63+
### Group for my locale does not exist
64+
65+
If you can't find group for your locale:
66+
67+
1. Translate 1000 strings or more on Crowdin for your locale
68+
2. Find at least one more translator for your locale
69+
3. Create a [new issue](https://github.com/nodejs/nodejs.org/issues/new?template=03-i18n.md) in this repo requesting the creation of a group for your locale
70+
71+
### Group for my locale is archived
72+
73+
If you find the group for your locale is archived:
74+
75+
1. Try to contact members of the group by creating a [new issue](https://github.com/nodejs/nodejs.org/issues/new?template=03-i18n.md) in this repo. Include a mention of the group so members get notified of the issue.
76+
2. If there is no response from members in 7 days and if you have already done 1000 strings or more on Crowdin for your locale, open an issue in https://github.com/nodejs/admin requesting the repository be unarchived.

0 commit comments

Comments
 (0)