Pulsar documentation translation httpscrowdin.comprojectapache-pulsar

Clone this repo:

Branches

  1. 72aa629 Update translation status for Concept-And-Architectures and Pulsar-Schema articles (#22) by ErhWen Kuo · 4 days ago master
  2. fcb86fc Update plusar quick start related translation status (#21) by ErhWen Kuo · 11 days ago
  3. 05c8a4d [Docs] Renaming translation guideline and workflow file name for multi-language tasks (#20) by ErhWen Kuo · 3 weeks ago
  4. c6e7c83 Separate simplified and traditional Chinese translation schedule (#19) by Jennifer Huang · 3 weeks ago
  5. 86181d1 Assign a new doc of trans (#11) by Sylvia · 7 weeks ago

Translation workflow and guidelines

Welcome to join the Pulsar translation project! Before translating, read translation workflow and guidelines.

You can find other language guidelines as listed below:

LanguageGuidelines
Chinese Simplified (zh-CN)README_zh-CN
Chinese Traditional (zh-TW)README_zh-TW

Workflow

You can find Apache Pulsar translation project on Crowdin. For further details about the functions of Crowdin, see Crowdin. Here are the steps of the translation workflow:

Join the Pulsar translation project

  1. Sign in Apache Pulsar Crowdin project. If you don’t have a Crowdin account, on the crowdin page, click SIGN UP at the upper right corner and fill in the information to create an account. If you have a GitHub, Facebook, Google, Twitter, or Gitlab account, you can link any of them to sign in.

  2. After signing in, click Join at the upper right corner on the crowdin page.

Note: The source language of Pulsar files is English. Currently the target languages of translation projects are Chinese, French, and Japanese.
Select a language. Take the Simplified Chinese Translation Project as an example.

Choose a file to translate and submit a PR

  1. Click Simplified Chinese Translation Project.
  2. Click master > docs, and check out the status of each file. Files in master > docs are the source files of the latest versions on Pulsar official website. You only need to translate these markdown files.
  • Green: translated and approved
  • Blue: translated but not approved
  • Grey: not translated

Based on your knowledge about Pulsar, you can translate the content that you are familiar with first.

After choosing the file to translate, please check it out in Translation schedule. If you find someone is translating this file, please choose another one. If not, you can create a PR and add the file name to Translation schedule. Then you can submit the PR.

Label Setting

  • Reviewers: No need to set up. Reviewers will receive the notification of PR you submitted automatically and will designate someone to handle it.
  • Assignees: Choose yourself to receive notifications.
  • Label: Choose “translation”.

Translating

While translating, you don’t need to translate the ID of the file and keep the tag the same as the source file.

Important
Don’t modify, omit or add a space in a tag, as the omission or relocation of a tag leads to mistakes shown on the website.

You can modify and save the content directly. Your version will appear automatically at the top of the translation list, as Crowdin will record different versions from different translators. TM AND MT TRANSLATION in the bottom-right corner offers you TMs in Pulsar, Crowdin, and other websites.

Tip: You can use and update Pulsar 文档翻译术语库 while translating.

Review

After finishing a translation, please leave a comment in your PR. For example, I've finished the translation, could you help review?

After receiving the comment, reviewers start to review. The reviewer can make simple comments and notify the translator. Direct discussion in PR is encouraged.

If there are no problems, the reviewer will approve this PR and merge it.

The following image gives a general workflow. The workflow source file is available at lucidchat. Masakazu shares a more detailed swimlane for the workflow.

Guidelines

For different language, there are some translation guidelines written to make sure the sytles consistency and reading fluency. Please read it before translation start.

LanguageGuidelines
Chinese Simplified (zh-CN)README_zh-CN
Chinese Traditional (zh-TW)README_zh-TW

Add you as a contributor

When your first pull request is merged, feel free to add your name to the contributor list.