> I found that the documentation on Dubbo official website is a bit > laggy, I think we should upgrade the document structure and content on > the Dubbo official website. My initial idea is to divide the document > into two parts, the first part is the facade document, and the second > part is the advanced document.
I totally agree with this point. I think it’s a good practice to separate the documentations into different levels and put them at different places. Those explaining the basic concepts, showcasing the basic usages of Dubbo should be placed in the most prominent place while the others related to usage of advanced features more similar to reference guides can be placed in somewhere that needs several clicks to reach. > Facade document: it is mainly used to introduce Dubbo and serve as a > guide for new Dubbo users, the directory structure is as follows: > > - What is Dubbo? > - - Introduction > - - Core Concepts > - - Dubbo Ecosystem > - Why use Dubbo? > - - Advantage > - How to use Dubbo? > - How to Contact the Dubbo Community? Would you like to work on the the current website to build the new scaffold with the basic structure you suggested so others interested in this task can work together on it. Jun > On Apr 12, 2022, at 12:32 PM, zhongming hua <[email protected]> wrote: > > Hi, all: > I found that the documentation on Dubbo official website is a bit > laggy, I think we should upgrade the document structure and content on > the Dubbo official website. My initial idea is to divide the document > into two parts, the first part is the facade document, and the second > part is the advanced document. > > Facade document: it is mainly used to introduce Dubbo and serve as a > guide for new Dubbo users, the directory structure is as follows: > > - What is Dubbo? > - - Introduction > - - Core Concepts > - - Dubbo Ecosystem > - Why use Dubbo? > - - Advantage > - How to use Dubbo? > - How to Contact the Dubbo Community? > > Advanced document: It will contain detailed information on various > projects in the Dubbo ecosystem. It will build different document > content according to different projects. The top-level structure > directory is as follows (The secondary directory will be determined by > different projects, such as the Quick start of Dubbo Java SDK and > Dubbo Golang SDK must be different): > - Introduction > - - Users > - Quick start > - Concepts & Architecture > - - FAQs > - Advanced Features & Usage > - Reference Manual > - Upgrades & Compatibility > - Contributing > - Overview > - Contribution Guideline > - Contributor Guideline > - Committer Guideline > > If you have different ideas, you can reply to the email for discussion. > > Best Regards! > Zhongming Hua
