You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by hj...@apache.org on 2019/07/22 01:47:31 UTC
[pulsar-translation] 01/01: Add some initial files,
and will improve them soon
This is an automated email from the ASF dual-hosted git repository.
hjf pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar-translation.git
commit 2f4661cfab51a7b177ed37cc9d01602911f91fc0
Author: Jinfeng Huang <hj...@streamnative.io>
AuthorDate: Mon Jul 22 09:47:13 2019 +0800
Add some initial files, and will improve them soon
---
.github/ISSUE_TEMPLATE.md | 14 +++
.github/ISSUE_TEMPLATE/bug_report.md | 30 ++++++
.github/ISSUE_TEMPLATE/feature_request.md | 20 ++++
.github/PULL_REQUEST_TEMPLATE.md | 48 +++++++++
CONTRIBUTING.md | 104 +++++++++++++++++++
CONTRIBUTORS.md | 13 +++
README.md | 161 ++++++++++++++++++++++++++++++
media/example-comma.jpg | Bin 0 -> 370095 bytes
media/id-tag.jpg | Bin 0 -> 216164 bytes
media/translation-interface.jpg | Bin 0 -> 882284 bytes
media/translation-status.jpg | Bin 0 -> 254840 bytes
media/translation-workflow.jpg | Bin 0 -> 51785 bytes
schedule.md | 14 +++
13 files changed, 404 insertions(+)
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..00c4b58
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,14 @@
+#### Expected behavior
+
+Tell us what should happen
+
+#### Actual behavior
+
+Tell us what happens instead
+
+#### Steps to reproduce
+
+How can we reproduce the issue
+
+#### System configuration
+**Pulsar version**: x.y
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..b9be206
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: type/bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..5b8022c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: type/feature
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..85285cc
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,48 @@
+<--
+### Contribution Checklist
+
+ - Name the pull request in the form "[Issue XYZ][component] Title of the pull request", where *XYZ* should be replaced by the actual issue number.
+ Skip *Issue XYZ* if there is no associated github issue for this pull request.
+ Skip *component* if you are unsure about which is the best component. E.g. `[docs] Fix typo in produce method`.
+
+ - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
+
+ - Each pull request should address only one issue, not mix up code from multiple issues.
+
+ - Each commit in the pull request has a meaningful commit message
+
+ - Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
+
+**(The sections below can be removed for hotfixes of typos)**
+-->
+
+*(If this PR fixes a github issue, please add `Fixes #<xyz>`.)*
+
+Fixes #<xyz>
+
+*(or if this PR is one task of a github issue, please add `Master Issue: #<xyz>` to link to the master issue.)*
+
+Master Issue: #<xyz>
+
+### Motivation
+
+*Explain here the context, and why you're making that change. What is the problem you're trying to solve.*
+
+### Modifications
+
+*Describe the modifications you've done.*
+
+### Verify this change
+
+- [ ] Make sure that the change is correct.
+- For how to check and verify, refer to [Translation and localization](https://github.com/apache/pulsar/tree/master/site2#translation-and-localization).
+
+
+### Documentation
+
+ - Is this pull request related to crowdin usage? (yes / no)
+ - Is this pull request related to translation quality? (yes / no)
+ - If yes, how to improve?
+ - Is this pull request related to translation guidelines?(yes / no)
+ - Is this pull request related to translation workflow?(yes / no)
+ - If a sth is not documented yet in this PR, please create a followup issue for adding the documentation.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..e087a98
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,104 @@
+# Making contributions
+
+## Markdown
+All files in the pulsar-translation repository are written in [Markdown](https://www.markdownguide.org/). If you do not know how to use Markdown, learn how to [get started](https://www.markdownguide.org/getting-started).
+
+
+## Workflow
+
+### Step 1: Fork
+
+1. Visit https://github.com/apache/pulsar-translation
+2. Click `Fork` button (top right) to establish a cloud-based fork.
+
+### Step 2: Clone fork to local machine
+
+Create your clone.
+
+```sh
+$ cd $working_dir
+$ git clone https://github.com/$user/pulsar-translation
+```
+
+Set your clone to track upstream repository.
+
+```sh
+$ cd $working_dir/pulsar-translation
+$ git remote add upstream https://github.com/apache/pulsar-translation.git
+```
+
+Use the `git remote -v` command, you find the output looks as follows:
+
+```
+origin https://github.com/$user/pulsar-translation.git (fetch)
+origin https://github.com/$user/pulsar-translation.git (push)
+upstream https://github.com/apache/pulsar-translation (fetch)
+upstream https://github.com/apache/pulsar-translation (push)
+```
+
+### Step 3: Keep your branch in sync
+
+Get your local master up to date.
+
+```sh
+$ cd $working_dir/pulsar-translation
+$ git checkout master
+$ git fetch upstream
+$ git rebase upstream/master
+$ git push origin master
+```
+
+### Step 4: Create your branch
+
+Branch from master.
+
+```sh
+$ git checkout -b myfeature
+```
+
+### Step 5: Edit the code
+
+You can now edit the code on the `myfeature` branch.
+
+
+### Step 6: Commit
+
+Commit your changes.
+
+```sh
+$ git add <filename>
+$ git commit -m "$add a comment"
+```
+
+Likely you'll go back and edit-build-test in a few cycles.
+
+The following commands might be helpful for you.
+
+```sh
+$ git add <filename> (used to add one file)
+git add -A (add all changes, including new/delete/modified files)
+git add -a -m "$add a comment" (add and commit modified and deleted files)
+git add -u (add modified and deleted files, not include new files)
+git add . (add new and modified files, not including deleted files)
+```
+
+### Step 7: Push
+
+When your commit is ready for review (or just to establish an offsite backup of your work), push your branch to your fork on `github.com`:
+
+```sh
+$ git push origin myfeature
+```
+
+### Step 8: Create a pull request
+
+1. Visit your fork at https://github.com/$user/pulsar-translation (replace `$user` obviously).
+2. Click the `Compare & pull request` button next to your `myfeature` branch.
+
+### Step 9: Get a code review
+
+Once you open your pull request, at least two reviewers will participate in reviewing. Those reviewers will conduct a thorough code review, looking for correctness, bugs, opportunities for improvement, documentation and comments, and style.
+
+Commit changes made in response to review comments to the same branch on your fork.
+
+Very small PRs are easy to review. Very large PRs are very difficult to review.
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
new file mode 100644
index 0000000..25800ea
--- /dev/null
+++ b/CONTRIBUTORS.md
@@ -0,0 +1,13 @@
+# Contributors
+
+- Bu Xing (https://github.com/xingbu110)
+- Francis Du (https://github.com/francis-du)
+- Jennifer Huang (https://github.com/Jennifer88huang)
+- Jia Zhai (https://github.com/jiazhai)
+- Lei Yang ()
+- Sijie Guo (https://github.com/sijie)
+- Susan (https://github.com/Ssssssusan)
+- Tianci Gao (https://github.com/bilahepan)
+- Tuten (https://github.com/tuteng)
+- Yiming Li ()
+- Ying Zhan (https://github.com/Monica-zy)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..31bd3d3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,161 @@
+# Translation workflow and guidelines
+
+Welcome to join Pulsar translation project! Before translating, read translation [workflow](#workflow) and [guidelines](#guidelines).
+
+## Workflow
+Pulsar 的翻译项目放在 [Apache Pulsar Crowdin](https://crowdin.com/project/apache-pulsar) 上。想进一步了解 Crowdin 功能，参阅 [Crowdin 网站](https://crowdin.com/) 。
+我们的翻译流程主要有以下几步。
+
+### 注册 Crowdin 账号，加入 Pulsar 翻译项目组
+登录 [Apache Pulsar Crowdin project](https://crowdin.com/project/apache-pulsar) 页面。如果没有 Crowdin 账户，点击右上角 **SIGN UP**，输入个人信息创建账户。如果你已经有 Github、Facebook，Google，Twitter，Gitlab 账号，直接在注册页面关联以上任意账号即可。
+
+登录成功后，在右上角选择 **Join（加入）**。
+> 注意
+> Pulsar 的源文件为英文，翻译项目分为中文、法语和日语。
+> 选择翻译目标语言，点击进入浏览。本文以“简体中文翻译项目”为例。
+
+### 选择翻译文件，提 PR
+点开“简体中文翻译项目”，进入 **master > docs** 目录中，查看每个文件的翻译进度。 **master > docs** 目录中的文件是 Pulsar 官网最新版本的源文件，只需要翻译这个目录中的 markdown 文件即可。其中：
+
+- 绿色：翻译并通过审阅
+- 蓝色：翻译未审阅
+- 灰色：未翻译
+
+
+
+根据自己对 Pulsar 及相关技术的理解，优先选择自己熟悉、尚未翻译的内容进行翻译。
+
+选择要翻译的文件后，查看 [Translation schedule](https://github.com/streamnative/translation-guidelines/schedule) 中是否有其他人在翻译这个文件。如果已经有，可以重新选择；如果没有，参考 [PR 模版](https://github.com/streamnative/translation-guidelines/blob/master/.github/PULL_REQUEST_TEMPLATE.md)，把自己要翻译的文件和姓名分别添加进 [Translation schedule](https://github.com/streamnative/translation-guidelines/schedule)，提交 PR。
+
+### 打标签
+- Reviewers：无需设置，负责人会自动收到您提交的 PR 申请，会安排人员处理。
+- Assignees：选择您自己，方便你后续收到进度通知。
+- Label：选择 `translation`。
+
+### 翻译
+译者开始翻译。在打开的翻译界面，文件 id 不需要翻译。翻译中的 tag 和源文件保持一致。
+> **重要
+> 一定不要修改、遗漏 tag，或者在 tag 后面加空格。tag 遗漏或错位会造成中文网站内容显示错乱。**
+
+
+
+如果看到有翻译需要修改的地方，直接在翻译界面修改、保存。你的翻译结果会自动出现在翻译列表的最上方，Crowdin 会自动记载不同译者的翻译版本。右下方的 **TM AND MT TRANSLATION** 中会提供 Pulsar、Crowdin 和网站上其他的术语库，翻译时可供参考。
+
+
+
+翻译过程中，如需参考或者追加 Pulsar 文档术语库，可以使用 [Pulsar 文档翻译术语库](https://shimo.im/sheets/5jozGy5WIUQQf5JV/MODOC)。
+
+### 审阅
+翻译完成后，在您提交的 PR 页面留言告知：
+“I've finished translation, could you please help review?”
+
+Reviewer 收到通知后，开始审阅翻译内容。审阅完成后，在 PR 中告知译者，并做简单点评反馈。如有需要讨论的地方，可以直接在 PR 中交流讨论。
+
+审阅无误后，reviewer approve 该 PR，并 merge。
+
+The following image gives a general workflow. The workflow source file is shared at [lucidchat](https://www.lucidchart.com/invitations/accept/0ebad9d8-ddf3-4a92-8ee6-e813a9bc58ff).
+Masakazu shares a more detailed [swimlane](https://swimlanes.io/d/8L04SRASw) for the workflow.
+
+
+## Guidelines ##
+本规范主要列出了一些常见的翻译问题，并提供了一些指导意见和建议。开始翻译前，请认真阅读并尽量遵守本文的规范，这能有效提高 Pulsar 翻译文件质量，统一翻译风格。
+
+### 1. 专有名词
+
+涉及到 Pulsar、Pulsar Functions、BookKeeper、ZooKeeper，按照上述大小写格式，保留英文不翻译。
+涉及到 broker，bookie，proxy 等，在句中保持英文小写形式，不用翻译。
+涉及到 topic，producer，consumer 等，翻译成“主题”，“生产者”，“消费者”。
+
+更多有关 Pulsar 文档术语库，参考 [Pulsar 文档翻译术语库](https://shimo.im/sheets/5jozGy5WIUQQf5JV/MODOC)。欢迎在这个文档补充和修改术语库。
+
+### 2. 汉字与英文、数字之间需空格
+
+汉字与英文或数字之间以空格隔开，以增强中英文混排的美观性和可读性。
+
+- Apache Pulsar是一个开源的分布式发布-订阅消息系统，由Apache软件基金会管理，并于2018年9月成为Apache顶级开源项目。❌
+
+- Apache Pulsar 是一个开源的分布式发布-订阅消息系统，由 Apache 软件基金会管理，并于 2018 年 9 月成为 Apache 顶级开源项目。✅
+
+**注意：**中文标点符号前后不需要跟空格，即使前后挨着的是英文单词。
+
+### 3. 中文标点符号
+
+中文里面请使用中文标点符号。英文中没有顿号，应该使用顿号的地方在英文中一般使用的是逗号，在翻译时应注意将其翻译为顿号。比如 “Kubernetes, Mesos, Docker“ 应该翻译成 “Kubernetes、Mesos、Docker“。
+
+在涉及到多个 items 时，如果是短语，后面用分号（；）结束，最后一个 item 以句号（。）结尾。
+
+如果每个 item 是个句子，或者已经使用过分号（；），每个 item 以句号结尾。
+
+ 
+
+上面这个例子中，使用句号（。）给每条实践结尾。
+
+### 4. “you“翻译为“你“
+
+为了风格统一，在翻译“you”时，可以省略时，尽量省略不用；必须使用时，用“你”，而不是“您”。
+
+### 5. 示例代码及注释
+
+示例代码中的注释最好能够翻译，当然也可以不翻译（当注释很简单时）。
+
+### 6. 意译优于直译
+
+翻译时尽量避免翻译腔，即把原文一字不漏地、逐句翻译出来。这样并不代表翻译更准确，有时候读着会很别扭。翻译完后，自己多读几遍，看看是否符合原意、是否绕口、是否简洁。在充分理解原文的基础上，可以适当采用意译的方式来翻译。有时候为了简化句子，有些数量词、助词、主语都可以省略。
+
+#### 6.1 ...的...的...的...
+
+比如英文中经常会用 ‘s 来表达从属关系，一字不落地都将其翻译成 “的“ 会有翻译腔。在中文里面有些 “的“ 完全可以去掉，不会影响表达的意思，还能简洁很多，看下面的例子。
+
+- Pulsar‘s documentation is located in the docs folder in Pulsar’s source code repository.
+
+当然，你可以将“的“字都翻译出来，但是读起来很不顺畅：
+
+- Pulsar 的文档位于 Pulsar 的源码仓库的 docs 文件夹中。 ❌
+
+去掉不必要的“的“字，就会简洁很多：
+
+- Pulsar 文档位于 Pulsar 源码仓库的 docs 文件夹中。 ✅
+
+#### 6.2 一个……
+
+英文一般比较严谨，当代表多个时，会使用复数名字，在翻译成中文时，一般不需要刻意把这些复数翻译出来。
+
+在英文里，当单数为可数名词时，前面一般会有 ”a“ 或 ”an“；中文中，我们一般不需要把”一个...“翻译出来。比如下面这个例子：
+
+- Using a Pulsar client with the proxy
+
+我们可以把”a“翻译成”一个“：
+
+- 使用有 proxy 的一个 Pulsar 客户端 ❌
+
+虽然看起来没什么问题，但是这里的”一个“是多余的，去掉之后不但不会影响翻译效果，而且更加简洁。
+
+- 使用有 proxy 的 Pulsar 客户端 ✅
+
+### 7. 尽量少用被动句
+
+英文文档中，有时以物为主语，中文翻译过程中，不需要把”被“字翻译出来。例如：
+
+ - 英文：Once the message above has been successfully published to the topic, you should see it in the standard output: Hello Pulsar.
+ - 原翻译：一旦上面的消息被成功发布到Topic中，您会在标准输出中看到它：Hello Pulsar”。 ❌
+ - 翻译调整：上面的消息成功发布到主题后，你会在标准输出中看到: Hello Pulsar。 ✅
+
+### 8. Will 将来时态
+英文中有“will”时，不用翻译成“将要......”，直接转化成一般现在时翻译就行。例如：
+
+- This will publish a single message to the Pulsar topic.
+- 原翻译：这将向Pulsar的Topic发送单条消息。 ❌
+- 翻译调整：（......）给 Pulsar 主题发布一条信息。 ✅
+
+### 9. 示例
+在英文中遇到 “Here‘s sth”，根据上下文语境做调整。例如：
+
+- Here's an example.
+- 原翻译：这里有一个示例。 ❌
+- 翻译调整：下面是一个示例。 ✅
+
+### 10. 语言简洁、流畅
+语言尽量简单、通顺，翻译完后，读一遍，适合中国人的阅读习惯。英语中有时会用从句，翻译中文时，尽量拆成几个简单的句子。
+
+## Join contributors
+When your first pull request is merged, feel free to add your name to the [contributor list](https://github.com/streamnative/translation-guidelines/blob/master/CONTRIBUTORS.md).
diff --git a/media/example-comma.jpg b/media/example-comma.jpg
new file mode 100644
index 0000000..5f0afe3
Binary files /dev/null and b/media/example-comma.jpg differ
diff --git a/media/id-tag.jpg b/media/id-tag.jpg
new file mode 100644
index 0000000..362fda0
Binary files /dev/null and b/media/id-tag.jpg differ
diff --git a/media/translation-interface.jpg b/media/translation-interface.jpg
new file mode 100644
index 0000000..a326879
Binary files /dev/null and b/media/translation-interface.jpg differ
diff --git a/media/translation-status.jpg b/media/translation-status.jpg
new file mode 100644
index 0000000..3632f2d
Binary files /dev/null and b/media/translation-status.jpg differ
diff --git a/media/translation-workflow.jpg b/media/translation-workflow.jpg
new file mode 100644
index 0000000..e43eb4c
Binary files /dev/null and b/media/translation-workflow.jpg differ
diff --git a/schedule.md b/schedule.md
new file mode 100644
index 0000000..f96f9fe
--- /dev/null
+++ b/schedule.md
@@ -0,0 +1,14 @@
+# Translation schedule
+
+
+Topic | Translator | Reviever | Status
+:-----|:-----------|:---------|:------
+admin-api-partitioned-topics | Tianci Gao | Jennifer Huang | Approved
+administration-proxy | Tianci Gao | Jennifer Huang | Approved
+admin api non persistent | liyiming2002 | | Translated
+admin api permission | liyiming 2002 | | Translated
+cookbooks-partitioned | Tianci Gao |Jennifer Huang | Approved
+cookbooks-message-queue | Ying Zhan | Susan | Approved
+
+
+