Apache Pulsar 翻译项目指南

Apache Pulsar 翻译项目指南

pulsar-translationPulsar documentation translation - https://crowdin.com/project/apache-pulsar项目地址:https://gitcode.com/gh_mirrors/pu/pulsar-translation

1. 项目目录结构及介绍

在apache/pulsar-translation仓库中，主要的目录结构如下：

1. master: 主分支，包含了Pulsar官网最新版原始英文文档。

   • docs: 此目录存储了所有待翻译的Markdown文件，它们对应Pulsar的官方文档。

2. translations: 包含各个语言的翻译分支，例如zh_CN, zh_TW, fr, ja等。

3. .crowdin.yaml: 配置文件，用于Crowdin平台自动化同步和构建。

4. .github: 存储GitHub操作的工作流文件，比如Pull Request模板。

5. README.md: 项目简介和翻译指南。

6. CODE_OF_CONDUCT.md: 社区行为准则。

2. 项目启动文件介绍

该项目主要用于文档翻译，而不是运行一个应用程序。启动翻译工作，主要是通过访问Apache Pulsar Crowdin项目，在那里你可以找到启动翻译的具体步骤。

1. 注册登录Crowdin账号。
2. 加入Pulsar翻译项目组。
3. 选择你需要参与翻译的语言分支。
4. 在Crowdin平台上选择未翻译或者待审核的文档进行翻译。

3. 项目配置文件介绍

• crowdin.yaml: 这个YAML文件定义了Crowdin与GitHub仓库之间的同步规则。它指示Crowdin如何处理不同语言的分支以及文件的映射关系。例如，docs目录下的Markdown文件会被同步到Crowdin的不同语言分支。

• .gitattributes: 该文件定义了Git的文本编码设置，确保在不同操作系统和编辑器之间正确处理文件。

• .github/workflows/crowdin.yml: GitHub Action的工作流程文件，用于自动将Crowdin上的翻译更新合并回GitHub仓库。

在进行翻译工作之前，理解这些配置文件有助于你更好地参与到项目协作中，并且保证翻译流程的顺利进行。完成翻译后，提交Pull Request，经项目维护者审批后，你的翻译将被合并至主分支，并反映在Pulsar的官方翻译文档中。

pulsar-translationPulsar documentation translation - https://crowdin.com/project/apache-pulsar项目地址:https://gitcode.com/gh_mirrors/pu/pulsar-translation