Documentation (or \u201cdocs\u201d) 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\u2019ll also be able to find answers on their own for the majority of questions as they use the software. <\/p>\n\n\n\n
Even before I start evaluating technical products or organizations, I usually check out their docs. If they have good docs and other on-boarding resources, this provides confidence in the quality of their product. It also speaks volumes about the organization\u2019s culture from attention to detail and community support to overall transparency. <\/p>\n\n\n\n
In the past, the main users of open source software were developers. Today, however, open source software is used by many end users who aren\u2019t developers such as business analysts, data scientists, and others. This is why having good docs is more important than ever<\/a>. <\/p>\n\n\n\n From the beginning, TiDB welcomed community contributors (more than 800 today and growing) to our projects\u2014the same is true of our docs<\/a>. Our docs pages are also a popular destination as they were visited by more than 300,000 users over the past 12 months. <\/p>\n\n\n\n We dedicate a lot of time and resources to our docs. But we also realize that no docs are perfect, and there\u2019s no one better than our user community to help us make them better. <\/p>\n\n\n\n End users can provide important insight as consumers of both our software and docs. In addition, as anyone who\u2019s done any type of writing can relate, it\u2019s always a good idea to have someone proofread your work. <\/p>\n\n\n\n In this spirit, we\u2019re excited to announce the inaugural TiDB Docs Dash on January 9 -11, 2024. The goal of this event is to bring TiDB community members together to have a fun and collaborative event where everyone can help improve TiDB and TiDB Cloud docs (they both reside in the same repository<\/a>). <\/p>\n\n\n\n Below are some examples of how community members can contribute: <\/p>\n\n\n\n This is just a partial list. We\u2019re sure TiDB community members will also be able to suggest other areas where we can make improvements. <\/p>\n\n\n\n Before the event, we will create a list of GitHub issues that community members can work on. Each issue will be associated with a docs page that needs to be debugged, translated, or improved. <\/p>\n\n\n\n During the event, community members can work on these issues by either submitting a PR or further contributing to issues with comments or suggestions in GitHub. Community members will earn points for each PR or issue they contribute to during the event (with more points awarded to PRs vs. issues).<\/p>\n\n\n\n We\u2019ll also welcome contributions outside of these issues, especially for things like fixing typos or improving readability. Community members will again earn points for PRs or creating new issues. <\/p>\n\n\n\n At the end of the event, we will tabulate the scores for all participants. We\u2019ll have fun awards and TiDB swag for the Top 5 contributors, as well as for anyone who made a valid contribution. We have more details on the scoring system, event swag, and other important information on an event page dedicated to TiDB Docs Dash<\/a>.\u00a0<\/p>\n\n\n\n If you\u2019re interested in helping improve TiDB docs, and want to join a fun community event, please save the dates of January 9-11, 2024 in your calendar!<\/p>\n\n\n\n We also created a new #2024-tidb-docs-dash <\/em>channel both on our Discord<\/a> \uadf8\ub9ac\uace0 Slack<\/a>. We encourage you to join those channels to look out for announcements! Just post any questions or suggestions for the event. <\/p>\n\n\n\n Most importantly, we encourage everyone to think about their experience with TiDB docs and where you wish it could be better. You can share your thoughts on our Discord or Slack channels. <\/p>\n\n\n\n We look forward to collaborating with all of you during our first TiDB Docs Dash!<\/p>","protected":false},"excerpt":{"rendered":" Documentation (or \u201cdocs\u201d) 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\u2019ll also be able to find answers on their own for the majority of questions as they use the software. Even before I start evaluating technical products or organizations, […]<\/p>\n","protected":false},"author":229,"featured_media":14638,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"ub_ctt_via":"","footnotes":""},"categories":[18],"tags":[111,29],"class_list":["post-14556","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-community","tag-tidb","tag-tutorial"],"acf":[],"featured_image_src":"https:\/\/static.pingcap.com\/files\/2023\/11\/15190759\/20231116-105219.png","author_info":{"display_name":"Raymond Paik","author_link":"https:\/\/www.pingcap.com\/ko\/blog\/author\/ray_paik\/"},"yoast_head":"\n<\/span>History of TiDB community contributions<\/span><\/h2>\n\n\n\n
<\/span>Announcing TiDB Docs Dash 2024<\/a><\/span><\/h2>\n\n\n\n
\n
<\/span>How will TiDB Docs Dash<\/a> work?\u00a0<\/span><\/h2>\n\n\n\n
<\/span>What\u2019s Next? <\/span><\/h2>\n\n\n\n