欢迎参与 KubeVela 官方文档翻译活动
來源 | 阿里巴巴云原生公眾號
背景
KubeVela v1.0 啟用了新的官網架構和文檔維護方式,新增功能包括文檔版本化控制、i18n 國際化以及自動化流程。但目前 KubeVela 官方文檔只有英文版,這提高了學習和使用 KubeVela 的門檻,不利于項目的傳播和發展,同時翻譯工作也能顯著提升語言能力,幫助我們拓寬閱讀技術資料的廣度,故組織本次活動。
活動舉辦
本次活動由 KubeVela 社區發起,KubeVela 社區和云原生社區 OAM SIG 共同舉辦。
活動流程
本次活動主要在?kubevela.io?repo 下進行,報名參與和認領任務都在?KubeVela 官方文檔翻譯登記中(請務必在表格中登記信息)。
點擊進入登記表。
開始翻譯
翻譯流程
參與翻譯活動的基本流程如下:
- 任務領取:在 KubeVela 官方文檔翻譯登記并認領任務;
- 提交:參與人員提交 PR 等待 review;
- 審閱:maintainer 審閱 PR;
- 終審:對 review 后的內容進行最后確認;
- 合并:merge 到 master 分支,任務結束。
參與指南
下面具體介紹參與翻譯的具體工作。
1. 準備工作
- 賬號:您需要先準備一個 GitHub 賬號。使用 Github 進行翻譯任務的認領和 PR 提交;
- 倉庫和分支管理?fork?kubevela.io 的倉庫,并作為自己倉庫的上游:git remote add upstream https://github.com/oam-dev/kubevela.io.git;
- 在自己的倉庫,也就是 origin 上進行翻譯;
- 一個任務新建一個 branch;
- Node.js 版本 >= 12.13.0 (可以使用node -v命令查看);
- Yarn 版本 >= 1.5(可以使用yarn --version命令查看)。
2. 參與步驟
Step 1:任務瀏覽
在?KubeVela 官方文檔翻譯登記并瀏覽有哪些任務可以認領。
Step 2:任務領取
在 KubeVela 官方文檔翻譯登記表格中編輯并認領任務。注意:為保證質量,同一譯者只能同時認領三個任務,完成后才可繼續認領。
Step 3:本地構建和預覽
# 命令安裝依賴 $ 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/ ? ClientCompiled 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 ? ClientCompiled successfully in 137.94ms請勿修改?/docs目錄下內容,中文文檔在?/i18n/zh/docusaurus-plugin-content-docs中,之后就可以在 http://localhost:3000/zh/ 中進行預覽了。
Step 4:提交 PR
確認翻譯完成就可以提交 PR 了,注意:為了方便 review 每篇翻譯為一個 PR,如果翻譯多篇請 checkout多個分支并提交多個 PR。
Step 5:審閱
由 maintainer 對 PR 進行 review。
Step 6:任務完成
翻譯合格的文章將會 merge 到 kubevela.io 的 master 分支進行發布。
總結
以上是生活随笔為你收集整理的欢迎参与 KubeVela 官方文档翻译活动的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 开源 1 年半 star 破 1.2 万
- 下一篇: 【全球年青人召集令】Hello Worl