IvorySQL Docs Co-Build - First Edition | 2025 Sep 23 - Dec 23 (UTC) | Participation Introduction

[faweizhao26]

🚀 Welcome to IvorySQL Docs Co-Build - First Edition！

To optimize IvorySQL documentation and provide everyone with a better documentation usage experience, the First Phase of the IvorySQL Documentation Co-construction Program is officially launched, and it will run from September 23 to December 23, 2025. At the same time, we also hope to take this opportunity to stimulate community vitality, gather IvorySQL community members together, and bring you an enjoyable collaborative experience.

During this three-month event, you will have the opportunity to collaborate with other community members to jointly improve the IvorySQL Documentation.

🗓️ Event Timeline

In this event, we have prepared a variety of documentation tasks for everyone, including writing documentation, optimizing documentation, and optimizing documentation structure.

• Task Claim Period: From now until 16:00 on December 23
• Task Submission Period: September 23, 2025 – September 23, 2025

Participation Method

You can view all available tasks in our Task List for the First Phase of IvorySQL Documentation Co-construction.

After selecting a task you are interested in, you can add the /assign command in the comment section of the issue or PR corresponding to the task to assign the task to yourself.

If an issue or PR already has an assignee, it means the task has been claimed; please select another task instead.

In addition to the tasks listed in this event, we also welcome you to point out other documentation issues you find by creating an issue or directly fix the issues you find by creating a PR.

The optimized documentation structure is as follows (currently for public viewing only and not yet updated to the official website documentation):https://www.kdocs.cn/l/cg7tqtbtTXYB

If any participant proposes suggestions on the documentation structure during the event and the suggestions are adopted, corresponding new tasks will be released.

Event Rewards

IvorySQL Contributor Certificate:

• Each participant will receive a custom electronic contributor certificate, which you can add to your GitHub personal homepage README to demonstrate your contributions to open-source documentation.

Contributor Prizes:

• Anyone who submits an issue with suggestions on the documentation structure or content, and the suggestions are finally adopted, will receive a participation award – the IvorySQL Community Peripheral Package, which includes: IvorySQL T-shirt, IvorySQL canvas bag, IvorySQL fridge magnet, and IvorySQL eye mask.

In addition, the following rewards are set based on the final points:

• First Prize: Beats over-ear Bluetooth headphones
• Second Prize: Custom mechanical keyboard
• Third Prize: 3C-certified power bank + 3-in-1 data cable

Points Rules

Contribution Method	Points	Remarks
Claim a Task	1	1 point is awarded for each task claimed
Submit a Task PR	5	5 points are awarded for each task PR submitted
Task PR is Merged	10	10 points are awarded for each task PR that is merged
Submit an Issue	2	2 points are awarded for each issue submitted
Issue is Adopted	4	4 points are awarded for each issue that is adopted

Note: The above rules apply only to the corresponding methods specified in this event; all the aforementioned PRs and issues must be submitted under the documentation repository.

PR Quick Start Guide

1. Fork the documentation repository:

Click the Fork button in the upper right corner of the repository and wait for the Fork process to complete.

IvorySQL Documentation: https://github.com/IvorySQL/ivorysql_docs

2. Clone the documentation repository and create a documentation PR: ◦ Refer to the instructions in each issue in the task list to submit a PR or provide suggestions in the issue.

   • Refer to the Quick Reference for AsciiDoc Syntax to write, modify, or optimize documentation.
   • Refer to the IvorySQL Community Contribution Guide to create a documentation PR.
   • In the PR description, please specify the issue related to this PR.

3. Pay attention to and submit modification suggestions for the PR:

   • After creating a PR, we will review the PR content and add modification suggestions for parts that need adjustments.
   • You can either accept the suggestions and make changes, or reject the suggestions and reply with your reasons below the suggestions.

Note: For PRs related to this event, please submit them to the master branch.

If you have any questions or need assistance, please feel free to add a comment to this issue.