乐趣区

关于云原生:欢迎参与-KubeVela-官方文档翻译活动

jiezi

起源 | 阿里巴巴云原生公众号

背景

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/ku…
  • 在本人的仓库，也就是 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/
✔ 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 分支进行公布。

退出移动版