- Dates/Time: 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 on January 9 -11, 2024! 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
- 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?
- Before the event, we will publish a list of GitHub issues that community members can work on.
- You can make your contribution by submitting a PR or further contributing to issues with comments or suggestions.
- 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. We may make some adjustments before the event (e.g., for awarding bonus points), but changes should be minor. Overall, you earn more points for working on issues from our issues list and more points will be awarded to PRs than to issues.
Contribution to issues in the TiDB Docs Dash issues list
| Activities | Points | Notes |
| PR submitted between January 9 – 11 | 4 | |
| PR merged by January 19 | 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 January 9 – 11 | 2 | |
| PR merged by January 19 | 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: Our goal is to publish the TiDB Docs Dash issues list in December before the Christmas holidays.
- Contributor badges/swag 🏆: When virtual badges and swag merchandise arrive, you will see them displayed here.
- Welcome video: Since this is a virtual event, we will create a welcome video in lieu of a live kickoff session so that you can get the latest on the issues list, recap of rules, and resources to help you get started. This will be published shortly before the event starts on January 9.
You can also look for new announcements in the #2024-tidb-docs-dash channel on our Discord and Slack.