TiDB Docs Dash | 2024 Jan 9 - Jan 12 (UTC) | Participation Introduction

[qiancai]

🚀 Welcome to 2024 TiDB Docs Dash!

🗓️ Dates/Time: January 9 at 08:00 UTC (your local time) – January 12 at 07:59 UTC (your local time)

Overview

We're excited to announce 2024 TiDB Docs Dash, a documentation hackathon aimed at bringing together TiDB community members for a fun and collaborative experience. In this three-day event, you'll have a chance to work with other members of the community while making a meaningful impact on TiDB documentation and TiDB Cloud documentation.

How to participant

You can find a full list of issues and tasks you can work on in our 2024 TiDB Docs Dash project. These issues are categorized as follows:

• Debug Documentation:

  • Verify a TiDB or TiDB Cloud document against the product to ensure accuracy and effectiveness.
  • You can find a list of the docs to be verified in the following issues:
    • English docs: https://github.com/pingcap/docs/issues/15480
    • Chinese docs: https://github.com/pingcap/docs-cn/issues/15772

• Translate Documentation:

  • Translate documentation from Chinese to English or vice versa to make it accessible to a wider audience.
  • You can find the summary issue of this category here: https://github.com/pingcap/docs/issues/15132

• Enrich Documentation:

  • Add more instructions and examples to existing documentation to make it more comprehensive and user-friendly.
  • You can find a list of the docs to be enriched in the following issues. You can enrich the English docs, Chinese docs, or both.
    • https://github.com/pingcap/docs/issues/15417
    • https://github.com/pingcap/docs/issues/15444
    • https://github.com/pingcap/docs/issues/15468

• Resolve Existing Doc issues:

  • Address existing documentation issues by providing suggestions or creating pull requests.
  • You can find a list of the issues to be resolved at https://github.com/orgs/pingcap/projects/51/views/3.

• Improve Documentation CI/HTML/PDF:

  • Write code to improve the CI pipeline, HTML presentation, and PDF output of the TiDB documentation.
  • You can find a list of relevant issues at https://github.com/orgs/pingcap/projects/51/views/3.

You can pick an issue or task from these categories based on your interest and expertise, and then contribute to it by assigning it to yourself and creating pull requests (PRs) to resolve it, or by commenting suggestions on the issue.

In addition to these published issues or tasks, you are also welcome to make other contributions, such as reporting issues on a docs page and creating PRs to fix typos.

Contribution recognition

• Custom digital badge:

  • Each participant will receive a custom digital badge as a token of appreciation for your valuable contribution, which can be added to your GitHub profile README.

• Top contributors swag:

  • The top 5 contributors with the highest contribution points will receive TiDB exclusive swags in addition to digital badges.

Quick guide for creating pull requests

1. Fork the target doc repository:

   • Fork the TiDB doc repository to create your own working branch.
     • TiDB and TiDB Cloud documentation in English: https://github.com/pingcap/docs
     • TiDB documentation in Chinese: https://github.com/pingcap/docs-cn

2. Contribute and submit pull request:

   • Follow instructions on the corresponding issue to make your contribution by enriching, testing, resolving, or translating documentation.

   • Follow TiDB Documentation Contributing Guide to submit a pull request (PR) from your branch to the target doc repository.

     Note: Currently, the TiDB Cloud documentation is in English only and it is stored in the release-7.5 branch of pingcap/docs for reusing the SQL documentation of TiDB. Hence, to create a pull request for TiDB Cloud documentation, make sure that your PR is based on the release-7.5 branch.

   • Indicate which issue this pull request resolves in the PR description.

3. Resolve comments in your PR:

   • After your PR is created, the repository maintainers will add labels to your PR for PR management and the documentation reviewers will add comments to the PR.
   • You can either accept a suggestion and make the change, or decline the suggestion and submit your reply right under the comment stating your reason.

Event details

• For more information such as event FAQ, see the event page of TiDB Docs Dash and Why Documentation is Important.
• For any queries or assistance, feel free to comment on this issue.

Thank you for being a part of TiDB Docs Dash and contributing to the growth of TiDB's open-source community!

[rpaik]

Thanks @qiancai. Under Section 3 under "How to contribute", do you want to add a couple of bullet points?

• You can contribute to issues by adding your comments/suggestions in the issue.
• We’ll also welcome contributions outside of these published issues.

[qiancai]

Hi @rpaik, thanks for the suggestion. I've updated the section. PTAL again.