Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CROWDIN how-to #1147

Merged
merged 2 commits into from
Dec 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions CROWDIN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Crowdin Translator How-To

Stellar Developer Docs use [Crowdin](https://crowdin.com/) for localization. This document provides steps and resources for managing Stellar Docusaurus Crowdin translations as a Crowdin user with a Translator role.

---

## Overview

As new English source files are added to the Stellar Docusaurus Documentation GitHub repository, they are automatically uploaded to Crowdin. From there, an automated AI translation is run on the files to translate them into other target languages (currently only Spanish at the time of writing).

In cases where the AI translation is inaccurate, a user with the Translator role will need to update and edit the translations manually.

---

## Translator User

To get started, you need to set up a Crowdin account and be added to the Stellar Documents Crowdin project. This involves creating a Crowdin user account and requesting access to the project from a project owner.
janewang marked this conversation as resolved.
Show resolved Hide resolved

For more details, see the following documentation:
[Create an Account](https://support.crowdin.com/for-translators/#create-an-account)

---

## Editor

As a translator, you will have access to the editor, where you can make changes to the content.

**Note:** Crowdin uses the term "strings" for content being translated.

You can access all translated documents via the Crowdin dashboard. From there, you can view each document in the editor.

For more details on working within the editor, see the following documentation:
[Working in the Editor](https://support.crowdin.com/for-translators/#working-in-the-editor)

For a more in-depth look, see:
[Online Editor Guide](https://support.crowdin.com/online-editor/)

---

## Glossary

For common words or phrases, it is good practice to add them to the glossary. The glossary helps the AI translator provide more accurate translations.
janewang marked this conversation as resolved.
Show resolved Hide resolved

Examples include:
- Words or phrases that need to be translated in a specific manner.
- Words or phrases that should not be translated at all.

For more information, see the following documentation:
[Glossary](https://support.crowdin.com/glossary/)

---

## Approving Translations

As documents are translated, they will be assigned a translation percentage highlighted in blue.

To manage files that have been checked or proofread, it is recommended to mark them as approved. Approved files will display an approved percentage highlighted in green.

**Note:** All translations are synced with the Stellar Docusaurus Documentation after they are reviewed and approved. Approval is a check for managing translation files that have been edited.

For more information on approving translations, see the following documentation:
[Proofreading](https://support.crowdin.com/online-editor/#proofreading)
Loading