KubeVela v1.0 啟用了新的官網架構和文檔維護方式,新增功能包括文檔版本化控制、i18n 國際化以及自動化流程。但目前 KubeVela 官方文檔只有英文版,這提高了學習和使用 KubeVela 的門檻,不利於項目的傳播和發展,同時翻譯工作也能顯著提升語言能力,幫助我們拓寬閱讀技術資料的廣度,故組織本次活動。
活動流程本次活動主要在 kubevela.io[1] repo 下進行,報名參與和認領任務都在 KubeVela 官方文檔翻譯登記[2] 中(請務必在表格中登記信息)。
開始翻譯參與翻譯活動的基本流程如下:
任務領取:在 KubeVela 官方文檔翻譯登記 登記並認領任務;合併:merge 到 master 分支,任務結束。參與指南下面具體介紹參與翻譯的具體工作。
準備工作帳號:你需要先準備一個 GitHub 帳號。使用 Github 進行翻譯任務的認領和 PR 提交。fork kubevela.io 的倉庫,並作為自己倉庫的上遊:git remote add upstream https://github.com/oam-dev/kubevela.io.gitNode.js 版本 >= 12.13.0 (可以使用 node -v 命令查看)Yarn 版本 >= 1.5(可以使用 yarn --version 命令查看)參與步驟Step1:任務瀏覽
在 KubeVela 官方文檔翻譯登記 登記並瀏覽有哪些任務可以認領。
Step2:任務領取
在 KubeVela 官方文檔翻譯登記 表格中編輯並認領任務。注意:為保證質量,同一譯者只能同時認領三個任務,完成後才可繼續認領。
Step3:本地構建和預覽
# 命令安裝依賴
$ yarn install
# 本地運行中文文檔
$ yarn run start -- --locale zh
yarn run v1.22.10
warning From Yarn 1.0 onwards, scripts don't require "--" for options to be forwarded. In a future version, any explicit "--" will be forwarded as-is to the scripts.
$ docusaurus start --locale zh
Starting the development server...
Docusaurus website is running at: http://localhost:3000/zh/
✔ Client
Compiled successfully in 7.54s
ℹ 「wds」: Project is running at http://localhost:3000/
ℹ 「wds」: webpack output is served from /zh/
ℹ 「wds」: Content not from webpack is served from /Users/saybot/own/kubevela.io
ℹ 「wds」: 404s will fallback to /index.html
✔ Client
Compiled successfully in 137.94ms請勿修改 /docs 目錄下內容,中文文檔在 /i18n/zh/docusaurus-plugin-content-docs 中,之後就可以在 http://localhost:3000/zh/ 中進行預覽了。
Step4:提交 PR
確認翻譯完成就可以提交 PR 了,注意:為了方便 review 每篇翻譯為一個 PR,如果翻譯多篇請 checkout 多個分支並提交多個 PR。
Step5:審閱
由 maintainer 對 PR 進行 review。
Step6:任務完成
翻譯合格的文章將會 merge 到 kubevela.io 的 master 分支進行發布。
翻譯要求翻譯完請先閱讀一遍,不要出現遺漏段落,保證文章通順、符合中文閱讀習慣。不追求嚴格一致,可以意譯。review 的時候也會檢驗。不會翻譯的詞彙可以不翻譯,可以在 PR 中說明,review 的時候會查看。Component、Workload、Trait 這些 OAM/KubeVela 裡面定義的專屬概念不要翻譯,我們也要加強這些詞彙的認知。可以在一篇新文章最開始出現的時候用括號加上中文翻譯。PR 命名規範 Translate <翻譯文件相對路徑>,如 Translate i18n/zh/docusaurus-plugin-content-docs/current/introduction.md。參考資料[1]kubevela.io: https://github.com/oam-dev/kubevela.io
[2]KubeVela 官方文檔翻譯登記: https://shimo.im/sheets/QrCwcDqh8xkRWKPC/MODOC
點擊【閱讀原文】閱讀網站原文。
中國 KubeCon + CloudNativeCon + Open Source Summit 虛擬大會
12 月 9 日至 10 日
https://www.lfasiallc.com/kubecon-cloudnativecon-open-source-summit-china/
贊助計劃書即將出爐
CNCF概況(幻燈片)
掃描二維碼聯繫我們!
CNCF (Cloud Native Computing Foundation)成立於2015年12月,隸屬於Linux Foundation,是非營利性組織。
CNCF(雲原生計算基金會)致力於培育和維護一個廠商中立的開源生態系統,來推廣雲原生技術。我們通過將最前沿的模式民主化,讓這些創新為大眾所用。請長按以下二維碼進行關注。