Dubbo3 Official Document Contributor Solicitation Order

Dubbo official website document writers summon order

Dubbo3 is a new milestone for Dubbo. Dubbo's ecological components (including Dubbo Java SDK, Dubbo Golang SDK, etc.) are moving closer to the goal of Dubbo3. In terms of user practice, including Alibaba, Taobao, Tmall, Ele.me, ICBC , Ping An Health and other enterprises have successfully upgraded the Dubbo3 version. As more enterprises and users pay attention to or upgrade Dubbo3, the entire community's demand for Dubbo3 documentation has become more urgent to help users use Dubbo3 functions correctly or know how to troubleshoot problems encountered.

The documents on the official website are currently facing two problems: the content of the documents is relatively lagging behind, and the document structure is not clear enough. In order to improve the quality of the documents on the Dubbo official website and make the documents on the official website of Dubbo help more users, the Dubbo community takes advantage of the milestone of Dubbo3, The document structure of Dubbo's official website has been comprehensively upgraded to solve the above two pain points. In the process of document construction and upgrade, the Dubbo community also hopes to gather some small partners to participate. And split some document tasks for community friends to claim.

Contributing partners can comprehensively understand Dubbo's features by writing documents, and according to the contribution ranking of contributors, they will get corresponding prizes, such as limited edition Dubbo community surrounding T-shirts, water cups, etc. In addition to this, active contributors have the opportunity to be nominated as Apache Dubbo Committers.

About Dubbo3's new document structure

In order to meet the needs of different users, the Dubbo community has upgraded the structure of the document. The new document is divided into two parts: "Facade Document" and "Advanced Document".

Getting Started Documentation

The facade document mainly introduces Dubbo from the perspective of the Dubbo ecosystem as a whole. In addition to introducing the Dubbo ecosystem, it also includes the ability to index to the advanced documents of various ecological components, which is mainly used to help users quickly understand Dubbo and find the content they need. . The specific document structure is as follows:

• What is Dubbo: It includes an introduction to Dubbo (defining Dubbo, what problems it solves, and showing key functions), core concepts (architecture and concept talk), and Dubbo ecology.
• Quick Start: Contains Golang Quick Start, Java Quick Start, Rust Quick Start, and more.
• 3.0 Overview: A brief introduction to new features such as Triple, Application-Level Service Discovery, IDL, Cloud Native, Mesh, and Multilingual.
• Example practice: Contains a complete demo to fully experience the practical example of Dubbo features.
• User Manual: Advanced documentation entry for language construction.
• FAQ: Other issues that users will care about, such as Benckmaking and compatibility

Advanced Documentation (language dependent)

Dubbo started with the Java SDK, and now has the Golang SDK, and the ecosystem is getting bigger and bigger. The advanced document is a detailed description of the content of the Dubbo ecological components, including all the details of the relationship that users want. The document top-level structure of all ecological components is the same, and the specific structure is as follows:

• Introduction
• Quick start
• Concept and Architecture
• Advanced Features and Usage
• Reference book
• Upgrades and Compatibility
• Participate and contribute

Advanced documents for various components are under construction, and the detailed directory of the Java SDK has been determined. For details, see:

https://github.com/apache/dubbo-awesome/issues/4

A complete plan for the Golang SDK documentation will be released at a later date.

How to participate in Dubbo3 document construction

1. According to personal interests, abilities, etc., find the content you want to participate in the following links:
   https://github.com/apache/dubbo-awesome/issues
2. Reply to assign under the corresponding issue to complete the claim.
3. Documentation will be written under this project:
   https://github.com/apache/dubbo-website
4. Read carefully:
   https://github.com/apache/dubbo-website#readme
5. Write related documents in the corresponding directory:
   https://github.com/apache/dubbo-website/tree/master/content/en/docs3-building/java-sdk
6. Submit the PR related to the content of the document to the Master branch, and fill in the relevant issues to be resolved when you initiate a PR in Github.

Precautions:

1. Before claiming an issue, check whether it is an unclaimed task.
2. Documentation is written in Markdown syntax. That is, the newly created document file should be xxx.md.
3. Document file names are in English.
4. Anyone who wants to participate in document writing can join the DingTalk group: 44647297, the application content is the claimed issue link + Github ID.

---

The first Alibaba Cloud Middleware Developer Conference will be held soon, sign up for the conference to get a briefing on the current situation of open source adoption of middleware in China!

Click here to register now!