天天看點

操作指南|最詳盡文檔翻譯志願指南

作為 Pulsar 社群的一員,想為社群做貢獻卻沒有頭緒嗎?最詳盡文檔翻譯指南來啦!Pulsar 中文社群貢獻者并不局限于貢獻代碼,撰寫、翻譯文檔也可以成為另一種意義上的 Pulsar Contributor!

本次為不熟悉文檔翻譯志願工作的小夥伴們帶來文檔翻譯貢獻指南,手把手帶你熟悉如何進行社群志願貢獻!

社群翻譯任務類型

目前,社群文檔翻譯任務分為三種:

•Apache Pulsar 官方文檔翻譯:主要任務是将 Apache Pulsar 網站上的英文文檔翻譯為中文,讓更多中文使用者更加容易閱讀。翻譯平台使用 Crowdin 進行翻譯送出、管理和稽核;•Apache Pulsar 英文部落格翻譯:内容範圍較廣,主要聚焦技術原理、案例等方向,英文文章翻譯在釋放給社群成員翻譯之前,我們均已取得原文作者授權;•Apache Pulsar Weekly(周報)翻譯:内容主要聚焦 Apache Pulsar 社群當周的亮點、重要特性、重要 bug 修複、活動和新聞、技術博文推薦幾個闆塊。

術語庫

為了保證英文術語翻譯的統一,友善大家了解,我們長期以來都在維護與 Apache Pulsar 相關的術語庫,目前術語庫詞條已達 500 餘條。建議在進行官方文檔和英文部落格翻譯前,仔細閱讀術語庫,降低後續翻譯審閱工作量。

術語表位址:https://shimo.im/sheets/5jozGy5WIUQQf5JV/MODOC

翻譯流程

參與文檔、部落格翻譯工作,簡要步驟如下:

1.回複「志願者」加入 Pulsar 中文社群志願者微信群,在 Translation Library 翻譯内容看闆[1]認領(在認領的Issue 上評論留言,并在群内@管理者 Tango 留言 Issue 序号進行認領)

2.點選認領的 Issue 任務,根據不同翻譯任務類型進入 Crowdin 平台或 Google Docs

3.注冊/登入自己的 Crowdin 賬号或 Google 賬戶(建議使用谷歌郵箱登陸)

4.開始進行 Issue 任務

5.任務完成後聯系管理者進行稽核工作

使用 Crowdin 翻譯技術文檔

1.請注意,把 Crowdin 圈紅處須設定成如圖所示(突出顯示未翻譯、已翻譯和 Review 後的字元串,以及是否顯示中文預覽),友善詳細的分辨需翻譯的内容。

操作指南|最詳盡文檔翻譯志願指南

2.此處的 ID、Lable 我們一般不翻譯,保留英文。

操作指南|最詳盡文檔翻譯志願指南

3.Crowdin 的翻譯是分段的,是以我們需要提前標明點選所想要翻譯的英文段(如圖左側紅色區域),系統會在右上角(圈紅區域)自動生成預設文本,在藍色區域内輸入我們翻譯的内容。

操作指南|最詳盡文檔翻譯志願指南

4.文本中黃色内容為預設連結,翻譯時保持原狀即可(可以點選上方黃色區域自動複制或點選左下角紅框内的按鈕進行全文本複制後替換其中的英文)。

操作指南|最詳盡文檔翻譯志願指南

5.Crowdin 自帶翻譯校對區域(如下圖圈紅區域,内容翻譯僅供參考),是以在翻譯過程中大家可以參考此處内容,但須避免“翻譯腔”。

操作指南|最詳盡文檔翻譯志願指南

6.如何辨識 Crowdin 需完成的内容:

•未翻譯内容為紅色•已經翻譯待 Review 内容為淡綠色,文本為灰色•管理者已經 Review 的内容為綠色,文本為黑色
操作指南|最詳盡文檔翻譯志願指南

我們的目标就是把所有的紅色區域全部變成綠色!以上為 Crowdin 的基本操作,你 get 了嘛?

操作指南|最詳盡文檔翻譯志願指南

翻譯英文部落格

1.打開認領的 Issue,圈紅部分為文檔翻譯的指南:

譯者指南:

•請将每段的翻譯一一對應放在相應段落下面,友善稽核;•全文請按照 Markdown 格式進行編寫,包括文章代碼、标題、超連結、引用等等;•請在文章開頭添加個人簡介。感謝每一位翻譯的志願者,我們希望能讓社群看到你的付出;請在閱讀後将譯者指南删除。

操作指南|最詳盡文檔翻譯志願指南

2.請在每段英文下方寫下對應的中文翻譯。

3.完成後在群内同步,編輯将邀請來自 StreamNative 和社群的技術專家對文章翻譯進行審閱。

4.譯者确認審閱意見,定稿。

翻譯 Weekly(周報)

1.打開認領的 Issue 内的文檔連結,圈紅部分為周報翻譯指南:

操作指南|最詳盡文檔翻譯志願指南

譯者指南:

•需向周報内填充的内容有:貢獻者名單、(本周亮點)、重要特性、重要 bug 修複、活動和新聞、博文推薦、結尾的 Pulsar 社群資料幾個闆塊;•周報請複制後放在相應的闆塊内;•每個部分皆有示例,注意事項請仔細閱讀并參考其中的示例樣式[3]進行編輯翻譯;•注意事項:•中英文之間需空格;•請在每段英文下方寫下對應的中文翻譯。•博文推薦需集合英文周報内 blog 與本期間微信公衆号上 Pulsar 相關内容;•文檔全篇請采用 markdown 格式,以便排版;

2.點選右上角編輯模式(Editing)進行翻譯編輯。

操作指南|最詳盡文檔翻譯志願指南

3.按照文檔内圈紅位置示例填充(本周亮點)、重要特性、重要 bug 修複幾個闆塊。

操作指南|最詳盡文檔翻譯志願指南

4.更新活動和新聞子產品(此處須放上該周内 Apache Pulsar 公衆号釋出最新的活動、新聞動态内容)如下圖圈紅區域。

操作指南|最詳盡文檔翻譯志願指南

5.博文推薦子產品(如上圖圈藍處需放上該周内周報内博文部分與 Apache Pulsar 公衆号釋出的中文部落格連結)。

6.更新結尾的譯者簡介及 Pulsar 社群資料(如下圖圈紅區域)。

操作指南|最詳盡文檔翻譯志願指南

• Pulsar 社群貢獻者、Star、Fork 數量更新位置請參考本連結:https://github.com/apache/pulsar ,如下截圖圈紅位置:

操作指南|最詳盡文檔翻譯志願指南

• Contributor 數量更新位置如下圖:

操作指南|最詳盡文檔翻譯志願指南

7.請更新導語部分的貢獻者名單及該周周報的具體日期(如圖圈紅位置)。

Apache Pulsar GitHub 倉庫在此期間 merged PR 的貢獻者名單,位址:https://github.com/apache/pulsar/pulls?q=is%3Apr+is%3Aclosed
操作指南|最詳盡文檔翻譯志願指南

8.完成後請在群内同步,編輯将邀請來自 StreamNative 和社群的技術專家對文章翻譯進行審閱。

9.譯者确認審閱意見,定稿。

文檔翻譯貢獻制度-積分制

在 Pulsar 社群,為社群出力的方式多種多樣,不隻是代碼的貢獻者,如果你對文檔和内容的翻譯整理、活動的組織策劃、社群的營運感興趣,都可以成為志願者的一員。