jprdonnelly/freeCodeCamp
1
0
Fork 0
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git synced 2026-02-27 11:04:01 -05:00
Code Issues Projects Releases Wiki Activity

docs(docs,i18n): update docs to conform with new translation flow (#46567)

Browse Source 
* docs(docs,i18n): update docs to conform with new translation flow

* docs(docs,i18n): add link to news platform

* docs(docs,i18n): update available languages

* docs(docs): change contributors chat room to Discord
This commit is contained in:
sidemt
2022-07-07 04:40:55 +09:00
committed by GitHub
parent c95b7ff712
commit c7955c4fbc
3 changed files with 36 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/FAQ.md
View File

@@ -10,7 +10,7 @@ freeCodeCamp runs on a modern JavaScript stack. If you're interested in contribu
Yes - You can contribute to any of the 30+ languages we have enabled on our translation platform.
We have user-contributed translations live in some languages. We intend to localize freeCodeCamp into several major world languages. You can read all about this in our [announcement here](https://www.freecodecamp.org/news/world-language-translation-effort).
We have user-contributed translations live in some languages. We intend to localize freeCodeCamp into several major world languages. You can read all about this in our [announcement here](https://www.freecodecamp.org/news/help-translate-freecodecamp-language/).
If you are interested in contributing to translations please makes sure you [read this guide](how-to-translate-files.md) first.

45
docs/how-to-translate-files.md
View File

@@ -1,20 +1,5 @@
# How to Translate freeCodeCamp's resources
It's our dream to provide you with the resources to learn, no matter the world language you speak. To help us with this massive effort, we have integrated our open-source code-base & curriculum with [Crowdin](https://crowdin.com/) - A tool to help us localize our code-base.
The translation workflow is split into two main activities:
- **Translating** curriculum files, documentation and UI elements like buttons, labels, etc.:
As a translator you can sign up on [our translation platform](https://translate.freecodecamp.org) and contribute translations in any of the 30+ languages enabled in there.
- **Proofreading** the translations for all of the above.
Proofreaders verify that the community contributed translations are uniform in tone and free of common issues like typos, etc. In short, they ensure that the quality of translations is high. Note that we do not use machine translations for a reason.
> [!WARNING]
> We are no longer using GitHub to translate files directly, if you are a returning contributor head to our [translation platform](https://translate.freecodecamp.org/) instead.
## Prepare yourself for contributions
> The freeCodeCamp Localization Roadmap – There Are No Speed Limits
@@ -27,7 +12,7 @@ We just ask that you understand the following:
Translating freeCodeCamp's resources is one of the most fun and rewarding experiences as a contributor, and it works best if you involve your friends and colleagues who speak the same world language as you.
We recommend joining [our community forum](https://forum.freecodecamp.org/c/contributors/3) and [contributors chat room](https://discord.gg/PRyKn3Vbay) with your friends and showing your interest before starting off with translations. Crowdin makes it easy to contribute translations, but it's still a lot of work.
You can start by reading [this announcement](https://www.freecodecamp.org/news/help-translate-freecodecamp-language/). We recommend joining [our community forum](https://forum.freecodecamp.org/c/contributors/3) and [Discord chat server](https://discord.gg/PRyKn3Vbay) with your friends and showing your interest before starting off with translations. Crowdin and other tools make it easy to contribute translations, but it's still a lot of work.
We want you to enjoy contributing and not burn out or lose interest.
@@ -39,7 +24,7 @@ We just ask that you understand the following:
freeCodeCamp.org is committed to providing these for free as always, however we need to prioritize resources for those who need them the most. The last thing we want is to shutdown servers for a language if the translation activity dies off & things become outdated.
Once a language reaches at least a few certifications on the curriculum we can begin deploying the language live on [`/learn`](https://www.freecodecamp.org/learn), while you continue to translate the remaining certifications.
For translating the curriculum, once a language reaches at least a few certifications we can begin deploying the language live on [`/learn`](https://www.freecodecamp.org/learn), while you continue to translate the remaining certifications.
For example, we would want to deploy at least the entire front-end certifications suite when we ship a new world language for the first time.
@@ -55,9 +40,29 @@ We just ask that you understand the following:
Once you have a small group of people (at least 4-5) interested and committed, we can hop on a call. We will explain all the details and walk you through some of the tools and processes.
## Overview of Crowdin
It's our dream to provide you with the resources to learn, no matter the world language you speak. To help us with this massive effort, we have integrated our open-source code-base & curriculum with [Crowdin](https://crowdin.com/) - A tool to help us localize our code-base.
> [!NOTE]
> We use a different tool and workflow for translating [news articles](https://www.freecodecamp.org/news). If you are interested in translating articles, read [this announcement](https://www.freecodecamp.org/news/help-translate-freecodecamp-language/) and reach out to your Language Lead.
The translation workflow is split into two main activities:
- **Translating** curriculum files, documentation and UI elements like buttons, labels, etc.:
As a translator you can sign up on [our translation platform](https://translate.freecodecamp.org) and contribute translations in any of the 30+ languages enabled in there.
- **Proofreading** the translations for all of the above.
Proofreaders verify that the community contributed translations are uniform in tone and free of common issues like typos, etc. In short, they ensure that the quality of translations is high. Note that we do not use machine translations for a reason.
> [!WARNING]
> We are no longer using GitHub to translate files directly, if you are a returning contributor head to our [translation platform](https://translate.freecodecamp.org/) instead.
## Getting started
First, make sure you come say "Hi" in our [contributors chat room](https://discord.gg/PRyKn3Vbay). We post regular updates about translating resources and answer a lot of your queries in there.
First, make sure you come say "Hi" in our [Discord](https://discord.gg/PRyKn3Vbay). We post regular updates about translating resources and answer a lot of your queries in there.
Next, head to our [translation platform](https://translate.freecodecamp.org/) and login (if you have not contributed to translations before, you will need to create an account).
@@ -106,7 +111,7 @@ Crowdin separates a document into translatable "strings", usually sentences. Eac
10. These two "pane" buttons will hide the left (document) and right (comments) views.
> [!NOTE]
> If you see a hidden string that includes translations, please notify us in the [contributors chat room](https://discord.gg/PRyKn3Vbay) so we can remove the translation from memory.
> If you see a hidden string that includes translations, please notify us in the [Discord](https://discord.gg/PRyKn3Vbay) so we can remove the translation from memory.
When you have completed a translation for a string, select the `Save` button to store your translation on Crowdin. Other contributors will then be able to vote on your translation and proofreaders will be able to approve it.
@@ -312,4 +317,4 @@ Follow these guidelines to ensure our translations are as accurate as possible:
- Do not add additional content. If you feel a challenge requires changes in the text content or additional information, you should propose the changes through a GitHub issue or a pull request that modifies the English file.
- Do not change the order of content.
If you have any questions, feel free to reach out to us in our [contributors chat room](https://discord.gg/PRyKn3Vbay) and we will be happy to assist you.
If you have any questions, feel free to reach out to us in our [Discord](https://discord.gg/PRyKn3Vbay) and we will be happy to assist you.

11
docs/index.md
View File

@@ -23,7 +23,16 @@ You can help expand and improve the curriculum. You can also update project user
We are localizing freeCodeCamp.org to major world languages.
Certifications are already live in some major world languages like [Chinese (中文)](https://chinese.freecodecamp.org/learn), [Spanish (Español)](https://www.freecodecamp.org/espanol/learn), [Italian (Italiano)](https://www.freecodecamp.org/italian/learn), [Portuguese (Português)](https://www.freecodecamp.org/portuguese/learn). We encourage you to read the [announcement here](https://www.freecodecamp.org/news/world-language-translation-effort) and share it with your friends to get them excited about this.
Certifications are already live in some major world languages like below:
- [Chinese (中文)](https://chinese.freecodecamp.org/learn)
- [Spanish (Español)](https://www.freecodecamp.org/espanol/learn)
- [Italian (Italiano)](https://www.freecodecamp.org/italian/learn)
- [Portuguese (Português)](https://www.freecodecamp.org/portuguese/learn)
- [Ukrainian (Українська)](https://www.freecodecamp.org/ukrainian/learn)
- [Japanese (日本語)](https://www.freecodecamp.org/japanese/learn)
We encourage you to read the [announcement here](https://www.freecodecamp.org/news/help-translate-freecodecamp-language/) and share it with your friends to get them excited about this.
**If you're interested in translating, here's [how to translate freeCodeCamp's resources](how-to-translate-files.md).**