【KubeVela 官方文檔翻譯】,歡迎你們踊躍參與

簡介:KubeVela v1.0 啓用了新的官網架構和文檔維護方式,新增功能包括文檔版本化控制、i18n 國際化以及自動化流程。但目前 KubeVela 官方文檔只有英文版,這提升了學習和使用 KubeVela 的門檻,不利於項目的傳播和發展,同時翻譯工做也能顯著提高語言能力,幫助咱們拓寬閱讀技術資料的廣度,故組織本次活動。

頭圖.png

來源 | 阿里巴巴雲原生公衆號html

背景

KubeVela v1.0 啓用了新的官網架構和文檔維護方式,新增功能包括文檔版本化控制、i18n 國際化以及自動化流程。但目前 KubeVela 官方文檔只有英文版,這提升了學習和使用 KubeVela 的門檻,不利於項目的傳播和發展,同時翻譯工做也能顯著提高語言能力,幫助咱們拓寬閱讀技術資料的廣度,故組織本次活動。node

活動舉辦

本次活動由 KubeVela 社區發起,KubeVela 社區和雲原生社區 OAM SIG 共同舉辦webpack

活動流程

本次活動主要在 kubevela.io repo 下進行,報名參與和認領任務都在 KubeVela 官方文檔翻譯登記中(請務必在表格中登記信息)。git

點擊進入登記表github

開始翻譯

1.png
翻譯流程web

參與翻譯活動的基本流程以下:架構

  • 任務領取:在 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 官方文檔翻譯登記並瀏覽有哪些任務能夠認領。ui

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/
✔ 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/ 中進行預覽了。

Step 4:提交 PR

確認翻譯完成就能夠提交 PR 了,注意:爲了方便 review 每篇翻譯爲一個 PR,若是翻譯多篇請 checkout多個分支並提交多個 PR。

Step 5:審閱

由 maintainer 對 PR 進行 review。

Step 6:任務完成

翻譯合格的文章將會 merge 到 kubevela.io 的 master 分支進行發佈。

本文內容由阿里雲實名註冊用戶自發貢獻,版權歸原做者全部,阿里雲開發者社區不擁有其著做權,亦不承擔相應法律責任。具體規則請查看《阿里雲開發者社區用戶服務協議》和《阿里雲開發者社區知識產權保護指引》。若是您發現本社區中有涉嫌抄襲的內容,填寫侵權投訴表單進行舉報,一經查實,本社區將馬上刪除涉嫌侵權內容。
相關文章
相關標籤/搜索