Step-by-Step Guide to Contribute KubeVela Documentation Translations

Background : KubeVela v1.0 launched a new website architecture with versioned docs, i18n support, and automation, but the official documentation is only in English, creating a learning barrier. To broaden access and improve language skills, the community organized a translation activity.

Organization : The event is initiated by the KubeVela community and co‑hosted with the Cloud Native OAM SIG.

Overall Workflow : Participants browse tasks on the KubeVela documentation translation registry, claim a task, translate locally, submit a Pull Request (PR), have the maintainer review it, and after final approval the changes are merged into the master branch of the kubevela.io repository.

Task claim: register and claim a task in the translation sheet.

Submit: push changes via PR and wait for review.

Review: maintainer reviews the PR.

Final approval: confirm the reviewed content.

Merge: merge into master and complete the task.

Preparation :

GitHub account is required for claiming tasks and submitting PRs.

Fork the kubevela.io repository ( https://github.com/oam-dev/kubevela.io.git) and add the upstream remote:

git remote add upstream https://github.com/oam-dev/kubevela.io.git

Work on your own fork (origin) and create a separate branch for each task.

Ensure Node.js version >= 12.13.0 ( node -v) and Yarn version >= 1.5 ( yarn --version).

Step‑by‑step translation process :

Step 1: Browse Tasks

Visit the translation registry and view available tasks.

Step 2: Claim a Task

Enter the registry sheet, edit the row, and claim the task (maximum three concurrent tasks per contributor).

Step 3: Build and Preview Locally

# Install dependencies
yarn install
# Run the Chinese version locally
yarn run start -- --locale zh
# Docusaurus will serve the site at http://localhost:3000/zh/

Do not modify files under /docs; Chinese content resides in /i18n/zh/docusaurus-plugin-content-docs.

Step 4: Submit PR

When translation is complete, submit a PR. One PR per translated page; if multiple pages are translated, create separate branches and PRs.

Step 5: Review

The maintainer reviews the PR.

Step 6: Task Completion

Approved translations are merged into the master branch of kubevela.io and published.

Reference Links :

[1] https://github.com/oam-dev/kubevela.io

[2] Translation registration sheet: https://shimo.im/sheets/QrCwcDqh8xkRWKPC/MODOC