IMPORTANT: Do not translate directly in this repo!
All content is translated via our Crowdin repo so we can keep our docs from going stale.
Getting involved is easy! Crowdin lets you sign in with your Github account.
| Role | Description | Language Proficiency |
|---|---|---|
| Translator | Translate content in Crowdin from English to target language | English: Intermediate+ Target: Native level preferred |
| Proofreader | Approve/reject translated content in Crowdin | English: Intermediate+ Target: Advanced |
Translators can double as proofreaders for other people's translations in their proficient language(s).
Yes, these are subjective requirements :) The goal is to make Redwood accessible by providing easy to read and engaging tutorial content.
To sign up for a role, simply request in Crowdin.
| Language | Translators | Proofreaders |
|---|---|---|
| French | @Thieffen, @noire.munich, @simoncrypta, @bugsfunny | @Thieffen |
| Spanish | @pdejuan, @ brian.gastesi | @clairefro, @pdejuan |
| Italian | @mlabate | |
| Portuguese | @renansoares, @luispinto23 | @renansoares |
Want to add yourself to a translator and/or proofreader role for a language? Don't see your language here and wish to contribute?
Tag @clairefro in a new issue in this repo and we'll get it started!
In Crowdin, go to your target language and look for any incomplete translations. Then translate untranslated strings directly in Crowdin's interface.
Please translate in the main branch folder
When translating, keep the frontmatter id the same as English.
This id is used for placing items correctly in the sidebar and must be the same for all locales of a given document.
title and sidebar_label however can and should be translated! Use double quotes "" - it's a habit to prevent YAML breaking on special characters like :.
example
English
---
id: welcome-to-redwood
title: "Welcome to Redwood"
sidebar_label: "Welcome to Redwood"
---
French (`id` stays in English!)
---
id: welcome-to-redwood
title: "Bienvenue chez Redwood"
sidebar_label: "Bienvenue chez Redwood"
---Leave code blocks as-is. There is an icon in the input box for translation that copies the source string in one click:
Crowdin is a pretty cool tool but it has its quirks - feel free to reach out to the internet or @clairefro if you get stuck.
I finished translating in Crowdin... Where's the PR?!?
Translations are only eligible for auto-PR once 100% approved. After approval, it takes ~10 minutes until the PR will sync to this repo.
I found a typo in an existing translation, can I update it?
Yes please!
I see weird symbols like <0> in Crowdin strings... what?
Those symbols are stand-ins for html tags like <a></a>. It is how Crowdin can map the tags to your translated content. In general, Crowdin tries to hide content that is not subject for translation, as to reduce clutter for translators. Do not delete these - keep them in your translation.
Are there term glossaries to ensure consistency between translators in the same language?
You can help us start some if you like! There is a glossary tab in Crowdin.
This whole process is a little confusing.
Your feedback will help us smooth things out!
Navigate to the translations page for your target locale from here
Look for blue! That means translated but not yet approved. Click the three dots next to any blue and select "Proofread"
You can now see a list of translated strings waiting to be approved.
You can either approve them in bulk by selecting all, or one by one carefully.
If you see something inaccurate or strange, do not approve that string. Instead, leave a comment for the translator by clicking the comment icon in the right pane. Please leave your comment in English, except for suggested phrasing.
Once you finish approving all translations in a file, that file becomes 100% green. Voila!
100% green files will automatically be PRed to this repo every ~10 mins.