- Dates/Times: January 9 at 08:00 UTC (your local time) – January 12 at 07:59 UTC (your local time)
- Location: Virtual
Documentation (or “docs”) is such a key part of any open-source software project. If you have good docs, users will find it easy to get started. They’ll also be able to discover answers on their own for the majority of questions as they use your software.
In this spirit, we’re excited to launch the inaugural TiDB Docs Dash! The goal of this event is to bring together TiDB community members for a fun and collaborative experience.
You’ll have a chance to meet other members of the community while helping to improve TiDB and TiDB Cloud docs (they both reside in the same repository).
You can find out more about why we organized this event, how it will work, cool prizes, and more from this blog post and the FAQ below.
Event FAQ
- When will the winners be announced?
- We will announce the winners during the week of February 5.
- Any requirements for participation?
- No registration is required to participate.
- However, you must have a GitHub account and sign the Contributor License Agreement (CLA).
- Where can I contribute?
- Main docs sites for TIDB & TiDB Cloud: https://github.com/pingcap/docs
- TiDB docs site in Chinese: https://github.com/pingcap/docs-cn
- TiDB docs website: https://github.com/pingcap/website-docs
- How do I make my contributions?
- Here’s a list of issues that you can work on during the event. Note that some of the issues are further divided into sub-issues and we will also be adding more issues leading up to the event.
- You can make your contribution by submitting a PR or further contributing to issues with comments or suggestions.
- If you are interested in working on a particular issue with no assignee, you can have the issue assigned to you today by typing the `/assign` command in the issue comment.
- We’ll also welcome contributions outside of these published issues.
- Recognizing your contributions
- We want to make this a fun event and ensure we recognize your contributions. Every community member that makes a valid contribution will receive a digital badge that you can add to your GitHub profile README.
- We will also award points for every contribution and tabulate scores for all participants. For the Top 5 contributors, we will be sending some new TiDB swag in addition to digital badges for the winners. (Details on how to add badges to your profile will be available with the badges)
- Is there a “scoring system”?
Below is an outline of how we will award points for your contributions. Overall, you earn more points for working on issues from our issues list and more points will be awarded to PRs than to issues. We may also award bonus points for significant contributions.
Contribution to issues in the TiDB Docs Dash issues list
| Activities | Points | Notes |
| PR submitted between event dates/time listed at the top of the page | 4 | |
| PR merged by February 1 | 10 | |
| Contribute to an issue (e.g., with comments, ideas, suggestions, etc.) | 2 | The judges will review the contribution and may decide not to award any points if the contribution is not of sufficient quality. |
Contribution to other issues
| Activities | Points | Notes |
| PR submitted between event dates/time listed at the top of the page | 2 | |
| PR merged by February 1 | 5 | |
| Contribute to an existing issue (e.g., with comments, ideas, suggestions, etc.) OR open a new issue. | 1 | The judges will review the contribution and may decide not to award any points if the contribution is not of sufficient quality. |
- Any other resources for the participants?
- We encourage you to review these materials before the event 😅
- How can I get help before & during the TiDB Docs Dash?
More to come
We will be updating this page periodically leading up to the event when we have news on items such as:
- Issues list: We’ll continue to add new issues for the TiDB Docs Dash. So we encourage you to visit the list periodically to see if there are issues that you want to take on!
- Contributor badges/swag 🏆: Below are some of the swag we’re planning for the event. We will add more photos and virtual badges here as they arrive.
- Every participant with a valid contribution will receive a TiDB Docs Dash contributor badge.
- Prizes for Top 1-5:
| Prize | Swag for Top 1-5 |
| 1st Place | Bose NEW QuietComfort Ultra Wireless Noise Cancelling Earbuds |
| 2nd Place | $100.00 Amazon.com Gift Card |
| 3rd Place | TiDB Mechanical Gaming Keyboard |
| 4th Place | TiDB Swag(Includes backpack and scalable cup) |
| 5th Place | TiDB Swag(Includes bucket hat and Ti Socks) |
You can also look for new announcements in the #2024-tidb-docs-dash channel on our Discord and Slack.