Operation Guide｜The most detailed document translation volunteer guide

As a member of the Pulsar community, want to contribute to the community but have no clue? The most detailed document translation guide is here! Pulsar Chinese community contributors are not limited to contributing code, writing and translating documents can also become a Pulsar Contributor in another sense!

This time, I will bring you a document translation contribution guide for those who are not familiar with the volunteer work of document translation, and let you familiarize yourself with how to make community volunteer contributions!

Community Translation Task Type

Currently, there are three types of community document translation tasks:

• Apache Pulsar official document translation: The main task is to translate the English documents on the Apache Pulsar website into Chinese, making it easier for more Chinese users to read. The translation platform uses Crowdin for translation submission, management and review;
• Apache Pulsar English blog translation: The content has a wide range, mainly focusing on technical principles, cases and other directions. Before the translation of English articles is released to community members for translation, we have obtained the authorization of the original author;
• Apache Pulsar Weekly (weekly) translation: The content mainly focuses on the highlights, important features, important bug fixes, events and news, and technical blog posts of the Apache Pulsar community for the week.

glossary

In order to ensure the unification of English terminology translation and facilitate everyone's understanding, we have been maintaining termbases related to Apache Pulsar for a long time. At present, the termbase has more than 500 entries. It is recommended to read the termbase carefully before translating official documents and English blogs to reduce the workload of subsequent translation review.

Glossary address: https://shimo.im/sheets/5jozGy5WIUQQf5JV/MODOC

Translation process

To participate in the translation of documents and blogs, the brief steps are as follows:

1. Scan the QR code at the end of the article to add Pulsar Bot friends, reply "Volunteer" to join the Pulsar Chinese Community Volunteer WeChat group, and claim it Translation Library translation content board Message Issue serial number to claim)
2. Click the claimed Issue task to enter the Crowdin platform or Google Docs according to different translation task types
3. Register/log in your own Crowdin account or Google account (recommended to use Google email to log in)
4. Start an Issue mission
5. After the task is completed, contact the administrator to review the work

Translate Technical Documentation with Crowdin

1. Please note that the red circle of Crowdin must be set as shown in the figure (highlight the untranslated, translated and Reviewed strings, and whether to display the Chinese preview), so as to facilitate the detailed identification of the content to be translated.

2. We generally do not translate the ID and Label here, and keep it in English.

3. The translation of Crowdin is segmented, so we need to select the English segment that we want to translate in advance (the red area on the left side of the figure), the system will automatically generate the default text in the upper right corner (circled red area), in the blue area Enter the content we translate.

4. The yellow content in the text is the default link, which can be kept as it is during translation (you can click the yellow area above to automatically copy or click the button in the red box in the lower left corner to copy the full text and replace the English in it).

5. Proofreading Crowdin carrying region (region below the red circle, the content translation for reference only), so that the translation process we can refer to the contents herein, subject avoid "translation chamber" .

6. How to identify what Crowdin needs to do:

• Untranslated content is red
• The content that has been translated to be reviewed is light green, and the text is gray
• The content that has been reviewed by the administrator is green, and the text is black

Our goal is to turn all the red areas into green! The above is the basic operation of Crowdin, have you got it?

Translate English Blog

1. Open the claimed Issue, and the circled part is the guide for document translation:

Translator's Guide:

• Please put the translation of each paragraph one by one under the corresponding paragraph for easy review;
• Please write the full text in Markdown format, including article code, title, hyperlinks, citations, etc.;
• Please add a bio at the beginning of the article. Thank you to every volunteer who translates, and we hope that the community can see your contribution; please delete the translator guide after reading it.

2. Please write the corresponding Chinese translation below each paragraph in English. 3. After the synchronization is completed, the editor will invite technical experts from StreamNative and the community to review the translation of the article. 4. The translator confirms the review comments and finalizes the draft.

Translate Weekly (Weekly)

1. Open the document link in the claimed Issue, and the red part is the translation guide for the weekly report:

Translator's Guide:

• The contents that need to be filled in the weekly report are: contributor list, (this week's highlights), important features, important bug fixes, events and news, blog post recommendations, and Pulsar community data at the end;
• The original text of the weekly report comes from the latest issue of Pulsar Community Weekly Update , please copy it and put it in the corresponding section;
• There are examples in each part, please read carefully and refer to the example style for editing and translation;
  Precautions:
• A space is required between Chinese and English;
• Please write the corresponding Chinese translation below each paragraph in English.
• The blog recommendation needs to collect the blog in the English weekly report and the Pulsar related content on the WeChat public account during this period;
• The entire document should be in markdown format for easy typesetting;

2. Click Editing in the upper right corner to edit the translation.

3. Fill several sections according to the example of the red position circled in the document (this week's highlights), important features, and important bug fixes.

4. Update activities and news modules (the latest activities and news content released by the Apache Pulsar public account during the week must be placed here) as shown in the red area as shown below.

5. Blog recommendation module (as shown in the blue circle in the picture above, you need to put the link of the blog section in the weekly report and the Chinese blog published by the Apache Pulsar official account).
6. Update the translator profile and Pulsar community data at the end of the update (the red area in the figure below).

• Please refer to this link for the updated location of the number of Pulsar community contributors, Stars, and Forks: https://github.com/apache/pulsar , the red location in the following screenshot:

• The update position of the number of contributors is as follows:

7. Please update the list of contributors in the introduction section and the specific date of the weekly report (as shown in the red circle).

List of contributors to merged PRs during this period for the Apache Pulsar GitHub repository at https://github.com/apache/pulsar/pulls?q=is%3Apr+is%3Aclosed

8. Please synchronize in the group after completion, and the editor will invite technical experts from StreamNative and the community to review the article translation.
9. The translator confirms the review comments and finalizes the draft.

Document Translation Contribution System - Points System

In the Pulsar community, there are many ways to contribute to the community, not just code contributors. If you are interested in document and content translation, event organization and planning, and community operations, you can become a volunteer.

Pulsar community volunteers adopt the point system, not to compare how much you have contributed, but to record your enthusiasm, so that we can regularly customize unique Pulsar volunteers for active friends to thank you for your dedication and love.

At present, the community volunteer contribution adopts a point system: the accumulated points will be cleared regularly, and an exclusive customized gift will be mailed to the top 3 friends. For details, please refer to the picture below👇

Pulsar Chinese community is recruiting document translation volunteers , please scan the QR code below to reply "volunteer" to join us, and act now!

"Scan code to add Bot friends"

Follow public account "Apache Pulsar" to get dry goods and news