Dubbo 官网文档写手召集令

Dubbo3 是 Dubbo 新的里程碑,Dubbo 的生态组件(包括 Dubbo Java SDK,Dubbo Golang SDK 等)都在向 Dubbo3 的方针靠拢,在用户实践方面,包括阿里巴巴、淘宝、天猫、饿了么、工商银行、安全健康等企业都已成功晋级 Dubbo3 版本,跟着更多的企业和用户关注或晋级 Dubbo3,整个社区对 Dubbo3 的文档的需求开端变得愈加迫切,以协助用户正确使用 Dubbo3 功用或知道怎么排查遇到的问题。

官网的文档目前首要面对两个问题:文档内容相对滞后、文档结构不够明晰,为了提高 Dubbo 官网文档的质量,让 Dubbo 官网的文档可以协助到更多的用户,Dubbo 社区借着 Dubbo3 这一里程碑,对 Dubbo 官网的文档结构进行了全面晋级,集火处理以上两个痛点。在文档建造和晋级的过程中,Dubbo 社区也希望能召集一些小伙伴一同参加进来。并拆分了一些文档使命给社区的小伙伴进行招领。

参加奉献的小伙伴可以经过编撰文档全面的了解 Dubbo 的特性,而且依据奉献者的奉献度排名,会得到相应的奖品,比如限量版 Dubbo 社区周边T恤、水杯等。除此之外活跃的奉献者有机会被提名为 Apache Dubbo Committer。

关于 Dubbo3 全新文档结构

为了满意不同用户的需求,Dubbo 社区对文档的结构做了晋级,全新的文档分为 “门面文档“ 和 “高档文档” 两部分。

入门文档

门面文档首要从 Dubbo 生态整体的视角来介绍 Dubbo,除了介绍 Dubbo 生态以外,它也包括索引到各个生态组件高档文档的才能,首要用于协助用户能快速了解 Dubbo,并从中找到自己所需的内容。详细的文档结构如下:

  • 什么是 Dubbo:包括 Dubbo 的简介(界说 Dubbo、处理什么问题、秀重点功用)、中心概念(架构与概念串讲)、Dubbo 生态。
  • 快速开端:包括 Golang 快速开端、Java 快速开端、Rust 快速开端等内容。
  • 3.0 速览:包括 Triple、应用级服务发现、IDL、云原生、Mesh、多言语等新特性的简述。
  • 示例实践:包括以一个完整的 demo 完整的体会 Dubbo 特性的实践示例。
  • 用户手册:分言语建造的高档文档进口。
  • FAQ:其他一些如 Benckmaking、兼容性等用户会关心的问题

高档文档(言语相关)

Dubbo 从 Java SDK 起家,到现在已经有 Golang SDK 、生态也越来越庞大,高档文档则是对 Dubbo 生态组件的内容进行细致的描绘,包括了所有用户想要联系的细节。所有生态组件的文档顶层结构都是一致的,详细的结构如下:

  • 简介
  • 快速入门
  • 概念和架构
  • 高档特性和用法
  • 参考手册
  • 晋级和兼容性
  • 参加奉献

各类组件的高档文档都正在建造中,其中 Java SDK 的详细目录已经确认,详情见:

github.com/apache/dubb…

Golang SDK 文档的完善计划将在稍后发布。

怎么参加 Dubbo3 文档建造

  1. 依据个人兴趣、才能等情况在下方链接中找到想要参加的内容: github.com/apache/dubb…

  2. 在对应 issue 下回复 assign,即可完成招领。

  3. 文档的编写将在该项目下进行: github.com/apache/dubb…

  4. 仔细阅读: github.com/apache/dubb…

  5. 在对应目录下编撰相关的文档: github.com/apache/dubb…

  6. 提交文档内容相关的 PR 到 Master 分支,并在 Github 中发起 PR 时,填写要处理的相关的 issue。

注意事项:

  1. 招领 issue 前先确认是否是为无人招领的使命。
  2. 文档选用 Markdown 语法进行编撰。即新建的文档文件应该为 xxx.md。
  3. 文档文件名称命名选用英文。
  4. 但凡想参加文档编撰的小伙伴都可以加入钉钉群:44647297,请求内容为招领的 issue 链接 + Github ID。

阿里云首届中间件开发者大会举行在即,报名参会获取国内中间件开源选用现状调研简报!

Dubbo3 官方文档贡献者征集令

点击此处,立即报名!