关于阿里云:Dubbo3-官方文档贡献者征集令

38次阅读

共计 1643 个字符,预计需要花费 5 分钟才能阅读完成。

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/dub…

Golang SDK 文档的欠缺打算将在稍后公布。

如何参加 Dubbo3 文档建设

  1. 依据个人兴趣、能力等状况在下方链接中找到想要参加的内容:
    https://github.com/apache/dub…
  2. 在对应 issue 下回复 assign,即可实现认领。
  3. 文档的编写将在该我的项目下进行:
    https://github.com/apache/dub…
  4. 仔细阅读:
    https://github.com/apache/dub…
  5. 在对应目录下撰写相干的文档:
    https://github.com/apache/dub…
  6. 提交文档内容相干的 PR 到 Master 分支,并在 Github 中发动 PR 时,填写要解决的相干的 issue。

注意事项:

  1. 认领 issue 前先确认是否是为无人认领的工作。
  2. 文档采纳 Markdown 语法进行撰写。即新建的文档文件应该为 xxx.md。
  3. 文档文件名称命名采纳英文。
  4. 但凡想参加文档撰写的小伙伴都能够退出钉钉群:44647297,申请内容为认领的 issue 链接 + Github ID。

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

点击此处,立刻报名!

正文完
 0