pingcap / pingcap/docs

Translate Documentation: Translate Pull Requests from Chinese to English or vice versa

Open
#15,132 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

2024-tidb-docs-dash
Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

Overview

The TiDB documentation in English and Chinese is currently maintained by creating a doc pull request (PR) in one language first, getting it approved, and then creating a corresponding doc PR in the other language.

To improve consistency between English and Chinese documentation, we welcome external contributors to translate pull requests with the translation/welcome label.

Required skills

  • Excellent writing skills in both English and Chinese
  • (Better to have) Some knowledge of databases and SQL

Docs that welcome translation

How to get started

  1. Pick a PR from the above list.
  2. Assign the PR to yourself by adding a comment /assign.
  3. Follow the TiDB Documentation Contributing Guide in English or Chinese to submit a pull request (PR) from your branch to the target repository.

Thank you for your contribution to maintaining consistency and accessibility in TiDB documentation! If you have any questions or need assistance, feel free to comment on this issue.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Chinese-to-English or English-to-Chinese project view linked in the issue and select a pull request marked for translation. Read the relevant English or Chinese TiDB Documentation Contributing Guide before following its submission process. Done means submitting the translated pull request to the target repository and maintaining consistency with the source pull request.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql
Domain
databases, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.