Skip to content

Commit 65f2536

Browse files
melissawmsteppi
andauthored
Add guide on translating with Crowdin (#2)
* Add guide on translating with Crowdin * Grammar fix Co-authored-by: Albert Steppi <[email protected]> * Add join discord step to instructions --------- Co-authored-by: Albert Steppi <[email protected]>
1 parent 78ed938 commit 65f2536

File tree

13 files changed

+64
-16
lines changed

13 files changed

+64
-16
lines changed

config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ params:
3535
url: /news/
3636
- title: About
3737
url: /about/
38-
# - title: Contribute
39-
# url: /contribute/
38+
- title: Translate
39+
url: /translate/
4040
footer:
4141
logo: logo.svg
4242
socialmediatitle: ""

content/contribute/_index.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

content/images/1-crowdin.png

1.37 MB
Loading

content/images/2-projects.png

833 KB
Loading

content/images/3-languages.png

1.07 MB
Loading

content/images/4-content.png

1.19 MB
Loading

content/images/5-translate.gif

8.09 MB
Loading

content/images/5-translate.webm

768 KB
Binary file not shown.

content/images/6-approve.png

2.65 MB
Loading

content/images/7-switcher.gif

5.51 MB
Loading

content/images/7-switcher.webm

814 KB
Binary file not shown.

content/images/palette.png

1004 Bytes
Loading

content/translate.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: How to translate content using Crowdin
3+
draft: false
4+
---
5+
6+
If you want to start translating content for Scientific Python projects, you can use Crowdin to help you manage the translation process. You can see which projects are currently set up with Crowdin in our [GitHub project board](https://github.com/orgs/Scientific-Python-Translations/projects/1).
7+
8+
You can also see [a similar guide in video format on YouTube](https://www.youtube.com/watch?v=xxmVM2MfrSw).
9+
10+
### 1. Create Crowdin profile
11+
12+
First, navigate to https://scientific-python.crowdin.com/ - note you will be logging in to or signing up for a Crowdin Enterprise account.
13+
14+
Create a username and password, or log in with your credentials (if you already have a GitHub account, you can use that to log in).
15+
16+
<img alt="Crowdin login page showing the options of creating a new username and password, and logging in with multiple services such as Google, Facebook, GitHub and Twitter." src="../images/1-crowdin.png" width=800/>
17+
18+
### 2. Join the Scientific Python Discord server and ask to be added as a translator
19+
20+
Join the [Scientific Python Discord server](https://discord.gg/vur45CbwMz) and ask to be added as a translator in the `#translation` channel. This will give you access to the projects that are currently being translated.
21+
22+
### 3. Select project you want to translate
23+
24+
In the Crowdin Workspace, select the project you want to work on.
25+
26+
<img alt="Crowdin workspace showing a user dashboard and 6 cards with a few Scientific Python projects' websites: Pandas, NumPy.org, Xarray, scipy.org, Zarr.dev and NetworkX." src="../images/2-projects.png" width=800/>
27+
28+
### 4. Select language you want to translate to
29+
30+
For each project, there will be a list of languages that the project is currently being translated into. Click on the language you want to translate to.
31+
32+
<img alt="Crowdin project page showing the NetworkX dashboard, with a list of languages that the project is currently being translated into including Arabic, Chinese Simplified, Japanese, Korean, Brazilian Portuguese, Russian and Spanish." src="../images/3-languages.png" width=800/>
33+
34+
### 5. Browse content
35+
36+
Depending on the project you chose, there will be more or less content to translate. Currently, our goal is to focus on the _brochure_ websites containing basic landing pages, news items and other static content. Full project documentation is not yet available for translation for most projects.
37+
38+
The source content to translate may be in Markdown, HTML, or other formats. You can use the Crowdin editor to translate content directly in the browser.
39+
40+
<img alt="Crowdin dashboard showing the SciPy.org project with a list of files to translate, including index.md, contributing.md, and other Markdown files." src="../images/4-content.png" width=800/>
41+
42+
### 6. Translate content
43+
44+
Crowdin provides a user-friendly interface for translating content directly in the browser. The editor will include automatic generated suggestions that you can use as a starting point for your translation. Keep in mind that these translations need human intervention and should be reviewed for accuracy.
45+
46+
<img alt="Crowdin editor translation workflow. On the left, the original text and on the right the translation panel. A suggestion of a snippet into Brazilian Portuguese is selected but is wrong. The translator edits the translation to be more accurate." src="../images/5-translate.gif" width=800/>
47+
48+
### 7. (Optional) Review and approve translation
49+
50+
When translations are ready, they can be reviewed by other contributors. This is an optional but recommended step, and it can help ensure that translations are accurate and consistent.
51+
52+
<img alt="Crowdin editor showing the translation review workflow. The reviewer can see the original text, the translation, and the suggestions. The reviewer can approve or delete the translation." src="../images/6-approve.png" width=800/>
53+
54+
### 8. See your translations online!
55+
56+
Once project maintainers are happy with the current state of the translations, they will publish the translations to the project website. You can see an example of this by navigating the NumPy website and switching the language in the top right corner.
57+
58+
<img alt="NumPy website showing the top right corner with a language switcher. The user can select between Brazilian Portuguese and Japanese." src="../images/7-switcher.gif" width=800/>
59+
60+
### Join our translations team!
61+
62+
If you are interested in helping us translate content, please join the `#translation` channel on the Scientific Python Discord server. We are always looking for new contributors to help us translate content into different languages. No prior experience is required, although some familiarity with the Scientific Python libraries is recommended.

0 commit comments

Comments
 (0)