Dubbo 3 是 Dubbo 新的里程碑,Dubbo 的生态组件(包含 Dubbo Java SDK,Dubbo Golang SDK 等)都在向 Dubbo 3 的指标聚拢,在用户实际方面,包含阿里巴巴、淘宝、天猫、饿了么、工商银行、安全衰弱等企业都已胜利降级 Dubbo 3 版本,随着更多的企业和用户关注或降级 Dubbo 3,整个社区对 Dubbo 3 的文档的需要开始变得更加迫切,以帮忙用户正确应用 Dubbo 3 性能或晓得如何排查遇到的问题。
为了晋升 Dubbo 3 文档的品质,Dubbo 社区在 6 月份中旬的时候收回了《Dubbo 3 官网文档贡献者召集令》。这两个月以来,Dubbo 官网收到了近 250 个 Commit,正是因为有了社区各位搭档的踊跃奉献,Dubbo 官网文档的构造和内容有了许许多多的扭转。
apache/dubbo-website 提交活跃度
本次体验优化聚焦的关注点
1. 文档全面对齐最新 Dubbo 3 版本
Dubbo 3 作为 Dubbo 的一个里程碑版本,做了泛滥的优化和架构调整。在本次文档优化中,咱们重点关注了这部分的文档问题,补充欠缺了 Dubbo 架构调整的内容、全新的利用级服务发现模型和 Triple 协定等的阐明应用文档。另外咱们也对一些疾速开始用例和已有性能的文档做了肯定的优化调整,来对齐 Dubbo 3 版本。
2. 文档架构优化,抽离出面向老手的入门文档
本次体验优化的过程中,咱们把原有的文档拆分为入门文档和 SDK 文档两个局部。面向 Dubbo 的入门用户,在入门文档模块能够疾速理解什么是 Dubbo、Dubbo 3 的新个性、疾速开始应用 Dubbo、基于场景示例的实际等。和入门文档模块与之对应的是 SDK 手册,SDK 手册中寄存了各个 SDK、工具的文档,包含了 Java SDK、Golang SDK、Dubbo Go Pixiu 等,面向想要深刻理解各个 SDK 的用户。
除了总体架构的分级,咱们也对 Java SDK 中一些子目录的构造进行了优化,如高级个性和用法目录下依照不同的场景拆散出流量治理、诊断与调优、晋升安全性等子目录。
入门文档局部
SDK 手册局部
3. 搜寻
Dubbo 作为一个 RPC 底层框架,提供了泛滥的性能,为了讲清楚性能怎么用、配置怎么配、原理是怎么样的等问题,设计了泛滥的文档。以后 Dubbo 的总文档数达到了一千多篇,纵使文档架构再怎么优化,大部分用户也无奈很快定位到具体的一篇文档。为了解决这个问题,咱们引入了 Algolia 搜寻工具,优化了对应的文档抓取逻辑,冀望用户能够通过关键字搜寻疾速找到所须要的文档。
Algolia 搜寻后果示例
4. 多语言生态
在 Dubbo 的倒退布局中,多语言生态是一个重要的组成部分,各个语言子社区都是 Dubbo 不可拆散的一个局部。在本次文档体验降级的过程中咱们也将各个子社区扩散的文档进行了整合,目前大部分的文档都曾经迁徙到了 SDK 手册中,入门文档的局部示例也和 Golang SDK 联结做了适配。
5. 异样链接修改
Dubbo 官网在历史上经验过好几个版本的大的迭代,很多网页的跳转链接存在着生效的问题,给浏览者带来了很不好的体验。在 dubbo-website 的 issue 列表中也有很多对于外链生效的反馈。为了从根本上解决这个问题,咱们在 GitHub Actions 工作流中引入了基于 htmltest 的链接校验逻辑,在每次提交的时候都会查看页面上的链接是否都还是无效,如果生效的话会有对应的报错报告,以此来确保跳转都是无效的。在第一次整体调整的过程中,咱们一共修复了 600+ 个链接生效问题。
布局中的内容
1. Dubbo 3 源码导读
Dubbo 3 作为 Dubbo 的里程碑版本做了很多的技术架构调整,为了让社区的小伙伴更容易了解 Dubbo 的原理设计,Dubbo 社区在布局实现新版的代码导读系列,预计在近期会和大家见面。
2. 应用 FAQ 文档
Dubbo 作为一个 RPC 框架,和开发态、运维态的工作都极为严密,在应用 Dubbo 的过程中难免会遇到非预期的报错,然而苦于对源码不够相熟无奈进行高效的排查。Dubbo 3 将全新降级 FAQ 文档机制,在报错的时候主动链接到官网文档中对应的 FAQ 文档,进步异样的排查效率,晋升总体应用体验。
写在最初
本次文档的优化只是 Dubbo 在易用性体验优化上的一个开始,因为 Dubbo 官网文档的数量泛滥,不免存在疏漏的中央,咱们欢送大家继续对包含 Dubbo 官网文档在内的 Dubbo 易用性体验提出问题倡议(间接提交 issue 就能够啦)。在将来咱们也将继续投入在 Dubbo 易用性优化的局部上,让 Dubbo 能被更多的人更容易地用上、用好。
点击此处,中转 Dubbo 官网。