隐语开源共建计划「第四季」

参加「文档季」的经验分享

翻译前

选完任务先别着急做，先确定是那个开源项目的任务，因为这期任务包括 SecretFlow、Kuscia、SCQL、YACL、PSI、SPU、HEU 开源项目，挺多的别搞错了。

然后，概览一遍文档翻译贡献指南，最后注意以下几项：

1. 先 fork 原项目再 clone，否则最后无法提交 PR（pull request）
2. 忌焦忌燥，遇到问题就问你的大模型老师，搞不定了就在群里摇人，不丢人。领了不做，才丢人。
3. 如果觉得这个活动不错，可以 Star 一下，这样后续的活动奖品才会越来越丰厚！（信我）

GitHub 地址：https://github.com/secretflow/secretflow

翻译中

我们所有的操作都是在项目对应的 docs 目录下进行，别乱跑。

update_po.sh 这个脚本的作用是生成和更新翻译文件（.po 文件）。.po 文件（Portable Object 文件）是一种用于软件本地化的文件格式。它们通常用于存储程序中的字符串及其翻译。每一个 .po 文件包含以下内容：

• 原文字符串（msgid）：这是程序中的原始字符串，通常是英文。
• 翻译字符串（msgstr）：这是与原文字符串对应的翻译。

所以，我们翻译文档只需要输入 msgstr 对应的值，其他的看不懂不要紧，因为用不到。翻译时建议都用“你”而不是“您”，可参考SecretFlow 官方文档

如果运行上述脚本的过程中，生成了非认领任务的 po 文件，可通过 git checkout . 扔掉改动，防止影响后面的提交。

如果在运行 sh update_po.sh 时遇到问题 Pandoc wasn't found.。这个错误出现在 Jupyter Notebook 中，通常是因为你的环境缺少了 Pandoc 工具。可以通过下面的命令安装 Pandoc，Windows 用户可以访问 Pandoc 官方网站 下载并安装最新的安装包。

sudo apt-get install pandoc # Linux brew install pandoc # macOS pandoc --version # 检查是否安装成功 

翻译完

翻译过程中/结束建议如果遇到非纯文字的段落，可以翻译完在本地查看下效果。

• 英>中：make SPHINXOPTS="-D language='zh_CN'" html
• 中>英：make SPHINXOPTS="-D language='en'" html

上面的命令效果是将翻译内容转化成 html 即生成静态网站，输出地址 _build/html，所以在本地查看效果的话，可以通过 Python 起一个服务就可以看啦！命令如下：

cd _build/html python -m http.server 8000 http://127.0.0.1:8000/ 

毕竟是给官方文档提交贡献，还是要严谨认真，最好自己先检查下、看看效果，要不老被打回也挺难受的。

提交 PR

1. commit 前建议检查 git 绑定的邮箱是否和你的 GitHub 账号一致，不一致可能会导致 CLA 签署失败
   • 查看：git config -l
   • 设置 email：git config --local user.email '[email protected]'

我就走到了这里（我认领的任务重了），剩下的交给其他的小伙伴！