The second phase of the document improvement plan | OceanBase invites you to build documents together

Project address: https://gitee.com/organizations/oceanbase/projects

Do you want to learn more quickly?

Do you enjoy the joy of sharing?

If your answer is Yes

So join us in the second phase of the document improvement plan!

On June 1st, we set sail again. We welcome you who love challenges and are willing to share to start the journey of document construction together!

Event process Event time: June 1st - June 30th

Document review time: July 1st - July 8th

Results announcement + community honors & incentives: July 11-July 15

The activity is suitable for students who improve learning efficiency and quickly learn distributed database knowledge

Master the skills of using OceanBase, and want to quickly achieve DBA from entry to mastery

People who understand OceanBase function modules and principles, and are engaged in database function development

Improve technical strength and obtain OBCP certified database practitioners

Activities to harvest accumulated knowledge power and form a personal growth system

Participate in the co-construction of open source projects and meet like-minded friends

Help novice users in the community get started with OceanBase faster

Once your suggestions are accepted, you will become a community contributor and be on the community honor roll

At the same time, we also prepared OBCP exam vouchers, camping tents, cervical pillows and some OceanBase peripherals and exclusive souvenirs to express our gratitude.

way of participation
01 What types of tasks are included?

It mainly includes the following four types, we recommend you to do it in the following ways:

Type 1: Irregular and low error classes

E.g:

• Typos

• Incorrect use of punctuation

• The document is malformed

Type 2: Unreasonable content structure and unclear language expression

E.g:

• Content with dependencies, out of sequence

• Ambiguous and ambiguous sentences, such as words such as "probably, possibly, maybe, very much, slightly"

Type 3: Content Error

E.g:

• Information errors such as concepts, definitions, parameter introductions, etc.

• The operation steps are wrong and the task cannot be completed according to the document

Type 4: Missing Content

E.g:

• Missing steps to complete tasks as documented

• Features supported by the product are not documented in the documentation

You can choose the direction you want to contribute in the documentation center, find the corresponding issue type and submit PR, and participate in the documentation improvement plan: https://open.oceanbase.com/docs/productDocs

If you are a user of the Community Edition for the first time, it is recommended to start with the product documentation: https://open.oceanbase.com/docs/observer-cn/V3.1.3/0000000000139358

02 How to start contributing?

From June 1st to June 30th, feedback documentation issues through the OceanBase open source official website is to participate in the community documentation improvement plan. Join now! Improve your skills, contribute to the community, and more surprises are waiting for you!

03 How to contribute?

1. Join the DingTalk group For those who want to participate in the event, Wall Crack recommends joining the DingTalk group on our only official website: 41203246. At that time, we will answer questions interactively in the group to solve all kinds of problems you encounter in the event🎉

Dingding group number: 41203246

2. Before the event, you need to have a gitee account.

3. Operation steps in the activity:

Log in to Gitee's OceanBase project, https://gitee.com/oceanbase .
Find the document for which you want to submit an issue. The document warehouses and addresses corresponding to each OceanBase product in Gitee are as follows.

3. Clone the local branch.

4. Modify the content and save it.

5. Submit and generate PR.

So far, you have successfully caught a 🐛 (submitted a PR)~

Follow-up questions are revised, we can continue to communicate in the DingTalk group~

In particular, only submit one question at a time. Don't put multiple issues in one commit.
The same problem occurs in different documents. If submitted multiple times, it is only counted as one problem.
If multiple people report the same issue, the pr with the earliest submission time will be adopted by default.

The following questions are considered invalid:

Problem cannot be located

Problem cannot be reproduced

The problem is not the first feedback

Question does not meet acceptance criteria

Business or Product Suggestion Category

Non-PC-side problem feedback

Other situations that have been judged invalid by internal audit

The growth of the community is inseparable from openness and sharing, and it is inseparable from the suggestions and contributions of every community user. We welcome every community user to join us to create a better reading experience and build better documents!

Finally, if you have any questions, you can contact us through the following ways~

Contact Us Welcome OceanBase enthusiasts, users and customers to contact us at any time and give feedback in the following ways:

Community Edition official website forum: https://ask.oceanbase.com/

Issue on the community version project website: https://github.com/oceanbase/oceanbase/issues

DingTalk Group: 33254054