Note:
This topic has been translated from a Chinese forum by GPT and might contain errors.Original topic: 【已结束】2024 TiDB 文档挑战赛！提 PR、提 Issue ，赢取 Bose 耳机、TiDB 限量款机械键盘等超丰富周边！
|
username: Billmay表妹
TiDB Documentation Challenge 2024 is here!
Event Background
Documentation is a key component of open-source software projects. Clear, accurate, and easy-to-understand documentation allows users to quickly get started with the product and solve most issues they encounter through self-help.
To provide a better documentation experience, we are excited to announce the first TiDB Documentation Challenge (TiDB Docs Dash) will take place from January 9 to 12, 2024. We also hope to use this opportunity to bring the TiDB community members together for a fun collaborative experience.
Through this event, you will have the chance to meet other community members and work together to improve the TiDB and TiDB Cloud documentation.
This post provides detailed information about the event’s purpose, operation, and more. We sincerely invite all TiDBers to participate in this event, optimize the documentation, and help more TiDBers! 
Latest Event Guide:
Event Time
During this event, we have prepared various types of documentation tasks for you, including “debugging” documentation, improving documentation, translating documentation, and solving documentation issues.
-
Task Claiming Time: From now until January 12, 16:00
-
Task Link: 2024 TiDB Docs Dash Issue List | 2024 TiDB 文档挑战赛任务列表 · GitHub
-
How to Claim: Open the task you are interested in and claim it by adding the
/assigncommand in the comment of the task’s issue or pull request (PR).
-
-
Task Submission Time: January 9, 16:00 - January 12, 16:00 (Beijing Time)
- Note: You need to submit the PR or issue within this time frame to receive event rewards.
For detailed information on how to participate, please refer to the FAQ section below.
Event Rewards
Participation Award:
By participating in the event in any of the following ways, you can receive a TiDB Docs Dash custom badge (which can be added to your GitHub profile) and a community badge (to be distributed after the event).
- Submit a documentation PR
- Submit a documentation issue
- Add valuable comments to a documentation issue
Badge:
PR Merged
-
Community Points: The first PR merged will earn 300 points & experience, and each additional PR merged will earn an extra 50 points & experience, up to a maximum of 2000 points & experience.
-
For those who have not registered in the community, you can click here to register. The points distributed after the event can be directly exchanged for community merchandise.
We will distribute community points within 7 working days after the event. If your GitHub ID and community nickname do not match (we will directly distribute points if they match), please contact the staff in case of any omissions.
Top 1-5 Scorers Prizes:
We have prepared exquisite prizes for the top five scorers.
For detailed scoring rules, please see the introduction below
| Award | Prize |
|---|---|
| First Place | Bose Bluetooth Noise-Canceling Headphones |
| Second Place | 500 RMB JD Gift Card |
| Third Place | TiDB Custom Mechanical Keyboard |
| Fourth Place | TiDB Custom Peripheral Gift Pack |
| Fifth Place | TiDB Custom Peripheral Gift Pack |
First Place Bose Bluetooth Noise-Canceling Headphones
Badge:
Second Place 500 RMB JD Gift Card
Badge:
Third Place TiDB Custom Mechanical Keyboard
Badge:
Fourth Place TiDB Custom Peripheral Gift Pack
Badge:
Fifth Place TiDB Custom Peripheral Gift Pack
Badge:
Participate in this post by leaving your GitHub ID to enter the raffle
Leave your GitHub ID to facilitate the subsequent distribution of points
Raffle Prize:
Community Backpack (choose one of two)
Raffle Deadline:
January 12, 2024, 16:00
Event FAQ
-
Are there any requirements to participate?
- No registration is required to participate, but you need to have a GitHub account and sign the Contributor License Agreement (CLA) when submitting a pull request (PR).
-
Where are the TiDB documentation source files?
-
TiDB Chinese Documentation: GitHub - pingcap/docs-cn: TiDB/TiKV/PD 中文文档
-
TiDB English Documentation: GitHub - pingcap/docs: TiDB database documentation.
-
TiDB Cloud English Documentation: GitHub - pingcap/docs at release-7.5
-
TiDB Documentation Website Code: GitHub - pingcap/website-docs: The next generation of PingCAP Docs. Powered by Gatsby ⚛️.
-
-
How do I participate?
-
Method 1: Submit a PR to complete tasks in the task list (recommended)
-
Choose a task you are interested in from the event task list and open the task.
-
Claim the task by adding the
/assigncommand in the comment of the task’s issue or pull request (PR). -
Submit a PR to solve the task, provide the related issue link in the PR description, and mark the PR with the
/label 2024-tidb-docs-dashcommand in the PR comment. Address any review suggestions received.
-
-
Method 2: Submit an issue to point out documentation problems, including but not limited to accuracy, completeness, and clarity issues.
-
Method 3: Submit a PR to solve any documentation problem.
-
Method 4: Provide valuable comments on issues in the event task list.
-
-
Are there any other reference materials for this contribution event?
It is recommended to read these materials before participating:
-
How can I get help before and during the event?
- If you have any questions, feel free to ask in the comment section of this post, and we will help you solve them.
Top 1-5 Scorers Event Scoring Explanation
The table below lists the basic scoring rules for the event. We may make some minor adjustments (e.g., reward points) before the event, but the changes should be minimal. Overall, handling tasks in the GitHub task list for this event will earn higher points than handling other tasks, and submitting PRs to solve issues will earn higher points than providing suggestions on issues.
For issues or PRs in the event task list, the scoring rules are as follows:
| Contribution | Points | Remarks |
|---|---|---|
| Submit PR between January 9, 16:00 - 12, 16:00 | 4 | Earn 4 points for each documentation PR submitted |
| PR merged before January 26 | 10 | Earn 10 points for each PR merged |
| Other types of contributions (e.g., sharing problem-solving ideas and suggestions on existing GitHub issues) | 2 | Earn 2 points for each valuable comment. We will evaluate the contributions received. Poor quality comments may not be awarded points. |
For issues or PRs not in the event task list, the scoring rules are as follows:
| Contribution Type | Points | Remarks |
|---|---|---|
| Submit PR between January 9, 16:00 - 12, 16:00 | 2 | Earn 2 points for each documentation PR submitted |
| PR merged before January 26 | 5 | Earn 5 points for each PR merged |
| Other types of contributions (e.g., creating GitHub issues to report documentation problems, or sharing problem-solving ideas and suggestions on existing GitHub issues) | 1 | Earn 1 point for each valuable comment. We will evaluate the contributions received. Poor quality comments may not be awarded points. |
Note: For outstanding PR contributions, we will also award additional bonus points.
2024 TiDB Documentation Challenge Group
If there are too many ads, we will adopt an invitation system to join the group. To join the group, please contact TiDB Robot on WeChat (tidbai)
Expected Announcement Time for Awards
Early February 2024, stay tuned!
|
username: 
|
username: 
|
username: 
|
username: 
|
username: 
|
username: 
|
username: 
|
username: 
|
username: 
|
username: 
|
username: 
|
username: 
|
username: 
|
username: 
|
username: