docs: Translation Flow (#40737)

Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>

docs/_sidebar.md

@@ -8,6 +8,9 @@
   - [Work on video challenges](how-to-help-with-video-challenges.md)
   - [Work on the news theme](how-to-work-on-the-news-theme.md)
   - [Work on the docs theme](how-to-work-on-the-docs-theme.md)
+- **Translation Contribution**
+  - [Translating a Curriculum File](how-to-translate-files.md)
+  - [Proofreading a Curriculum File](how-to-proofread-files.md)
 - **Optional Guides**
   - [Catch outgoing emails locally](how-to-catch-outgoing-emails-locally.md)
   - [Set up freeCodeCamp on WSL](how-to-setup-wsl.md)

docs/how-to-proofread-files.md

@@ -0,0 +1,43 @@
+# How to Proofread Translations
+
+Our proofreading team is responsible for ensuring that translations accurately reflect the source text.
+
+To begin proofreading, visit [our translation site](https://translate.freecodecamp.org) and login. Then select "Go to console" in the top navigation bar to switch from the public view to the workspace view.
+
+## Select a File
+
+You should see the list of projects you have been granted access to. Select the project that you would like to proofread, then select the language.
+
+![Image - Proofreading File Tree](./images/crowdin/proof-file-tree.png)
+
+You should now see the list of available files. Choose your file by selecting the `Proofread` button on the right of that file, then choosing `Proofreading` from the drop-down menu that appears.
+
+> [!NOTE]
+> If you are in this workspace view, but want to work on [translating a file](./how-to-translate-files.md) instead of proofreading, you may select `Crowdsourcing` from the dropdown menu instead.
+
+## Proofread Translations
+
+![Image - Proofreading View](./images/crowdin/proofread.png)
+
+<!--Add proofread/crowdsource button to image-->
+
+Here you will see the list of strings in the selected file, with their related translations. The translation that is displayed here is the translation which has received the highest score (between upvotes and downvotes) from the translation community.
+
+While you are able to view *all* proposed translations for a given string, the community scores (determined by the upvotes and downvotes) should be taken in to consideration when choosing which translation to approve. The community is able to review proposed translations and recommend which one is most accurate and clear.
+
+1. This is the original string (in English).
+2. This is the matching translated string. The most popular translation proposal, based on upvotes and downvotes, will be displayed here.
+3. Clicking this checkmark button will approve that translation.
+4. Crowdin will display the status of each string. `Done` means a translation has been approved and will be downloaded on our next Crowdin pull. `Todo` means the string has not been proofread. `Hidden` means the string is locked and *should not be translated*. `Comment` means the string has a related comment.
+5. Translations can be selected with the checkboxes and approved here in one bulk action.
+6. You can view the community proposed translations, their popularity scores, and Crowdin suggested translations here.
+7. This button shows/hides the right-hand side display pane, where you can view translations, comments, translation memory, and glossary terms.
+8. Crowdin displays error messages here from the quality assurance checks. In other words, if something does not seem correct in the translation, Crowdin will notify you. These translations should be approved with care.
+
+> [!WARNING]
+> Approving a string in the proofreading view will mark it as complete and it will be downloaded in our next pull from Crowdin to GitHub.
+
+No additional actions are required once a file has been proofread. If you have any questions, or are interested in becoming a proofreader, feel free to reach out to us in our [translators chat room](https://chat.freecodecamp.org/translators).
+
+> [!NOTE]
+> Crowdin will allow you to approve your own translations. In general, it is best to allow another proofreader to review your proposed translations as extra safety to ensure there are no errors.

docs/how-to-translate-files.md

@@ -0,0 +1,80 @@
+# How to Translate a File
+
+> [!NOTE]
+> All translations are handled through https://translate.freecodecamp.org - we are no longer using GitHub to translate files directly.
+
+To begin, head to our translation website and login (if you have not contributed to translations before, you will need to create an account).
+
+## Select a Project and File
+
+You should see two "projects" available for translation: The `Contributing Documentation` project, which contains the files for this documentation site, and the `Coding Curriculum` project, which contains our challenge files for `/learn`.
+
+Select which project you want to contribute to, and you will see a list of available languages for translation.
+
+![Image - List of available languages](./images/crowdin/languages.png)
+
+Select the language you want to work on, and you will see the complete file tree.
+
+![Image - List of available files](./images/crowdin/file-tree.png)
+
+Each file and folder will show a progress bar. The **blue** portion of the progress bar indicates what percentage of the file has been translated, while the **green** portion of the progress bar indicates what percentage of the file has been approved by the proofreading team.
+
+Select a file to work on and Crowdin will open the editor view.
+
+## Translate the File
+
+![Image - Editor View](./images/crowdin/editor.png)
+
+Crowdin separates a document into translatable "strings", usually sentences. Each string is translated individually. Referring to the image above:
+
+1. A string highlighted in green already has a proposed translation.
+2. A string highlighted in red does *not* have a proposed translation.
+3. A string with greyed out text is not translatable. This is the case for code blocks and other content that must not be translated. You will be unable to select these strings in the editor.
+4. If a contributor has proposed a translation to a string, Crowdin will display those proposals here. You will not be able to save an identical translation - instead, if a translation is accurate, you should click the `+` icon to "upvote" it. An inaccurate translation can be "downvoted" with the `-` icon.
+5. Crowdin will recommend translations based on Translation Memory (TM) or Machine Translation (MT). Translation Memory refers to similar or identical strings that we have translated/approved in other files. Machine Translation refers to translations recommended by their integrated library.
+6. This is the editor pane, where you may write your proposed translation for the selected string.
+7. The currently selected string in the editor will be highlighted in yellow.
+8. Here you will see tags indicating the state of the string. `Done` means the string has at least one proposed translation. `Todo` means the string does not have any proposed translations.
+9. Here you can see the comments window. If you have questions or concerns about a particular string, you can leave a comment on the string here for other translators to see.
+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 [translators chat room](https://chat.freecodecamp.org/translators) 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.
+
+You are welcome to translate as many strings as you like - there are no additional steps required when you complete a full file or propose a new translation. Clicking the `Save` button is all that is needed to store a translation.
+
+> [!NOTE]
+> If you see something in the English source file that is inaccurate or incorrect, please do not fix it through the translation flow. Instead, leave a comment on the string to notify us that there is a discrepancy, or create a GitHub issue.
+
+## Rate Translations
+
+Crowdin allows you to rate the existing proposed translations. If you attempt to save a translation, you may see a message indicating that you cannot save a duplicate translation - this means another contributor has proposed that identical translation. If you agree with that translation, click the `+` button to "upvote" the translation.
+
+If you see a translation that is inaccurate or does not provide the same clarity as the original string, click the `-` button to "downvote" the translation.
+
+Crowdin uses these votes to give a score to each proposed translation for a string, which helps the proofreading team determine which translation is the best fit for each string.
+
+## Quality Assurance Checks
+
+We have enabled some quality assurance steps that will verify a translation is as accurate as possible - this helps our proofreaders review proposed translations.
+
+When you attempt to save a translation, you may see a warning message appear with a notification regarding your proposed translation.
+
+![Image - QA Warning Message](./images/crowdin/qa-message.png)
+
+This message appears when Crowdin's QA system has identified a potential error in the proposed translation. In this example, we have modified the text of a `<code>` tag and Crowdin has caught that. 
+
+> [!WARNING]
+> You have the option to save a translation in spite of errors, but this should be done only in circumstances where the error might be incorrect.
+
+## Translation Best Practices
+
+Follow these guidelines to ensure our translations are as accurate as possible:
+
+- Do not translate content within `<code>` tags. These tags indicate text that is found in code and should be left in English.
+- 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 [translators chat room](https://chat.freecodecamp.org/translators) and we will be happy to assist you.