Dubbo3 官方文档贡献者征集令
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 的详细目录已经确定,详情见:
https://github.com/apache/dubbo-awesome/issues/4
Golang SDK 文档的完善计划将在稍后发布。
如何参与 Dubbo3 文档建设
-
根据个人兴趣、能力等情况在下方链接中找到想要参与的内容:
https://github.com/apache/dubbo-awesome/issues -
在对应 issue 下回复 assign,即可完成认领。
-
文档的编写将在该项目下进行:
https://github.com/apache/dubbo-website -
在对应目录下撰写相关的文档:
https://github.com/apache/dubbo-website/tree/master/content/zh/docs3-building/java-sdk -
提交文档内容相关的 PR 到 Master 分支,并在 Github 中发起 PR 时,填写要解决的相关的 issue。
注意事项:
- 认领 issue 前先确认是否是为无人认领的任务。
- 文档采用 Markdown 语法进行撰写。即新建的文档文件应该为 xxx.md。
- 文档文件名称命名采用英文。
- 凡是想参与文档撰写的小伙伴都可以加入钉钉群:44647297,申请内容为认领的 issue 链接 + Github ID。
阿里云首届中间件开发者大会举办在即,报名参会获取国内中间件开源采用现状调研简报!
点击此处,立即报名!