Dubbo3 官方文档贡献者征集令

本文涉及的产品
容器镜像服务 ACR,镜像仓库100个 不限时长
应用实时监控服务-用户体验监控,每月100OCU免费额度
性能测试 PTS,5000VUM额度
简介: 在文档建设和升级的过程中,Dubbo 社区也希望能召集一些小伙伴一起参与进来。并拆分了一些文档任务给社区的小伙伴进行认领。

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 文档建设


  1. 根据个人兴趣、能力等情况在下方链接中找到想要参与的内容:
    https://github.com/apache/dubbo-awesome/issues
  2. 在对应 issue 下回复 assign,即可完成认领。
  3. 文档的编写将在该项目下进行:
    https://github.com/apache/dubbo-website
  4. 仔细阅读:
    https://github.com/apache/dubbo-website#readme
  5. 在对应目录下撰写相关的文档:
    https://github.com/apache/dubbo-website/tree/master/content/zh/docs3-building/java-sdk
  6. 提交文档内容相关的 PR 到 Master 分支,并在 Github 中发起 PR 时,填写要解决的相关的 issue。


注意事项:


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




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


1.png


点击此处,立即报名!


    相关文章
    |
    5月前
    |
    XML Dubbo Java
    参考Dubbo3官方文档做的学习笔记
    这篇文章是关于Dubbo3的学习笔记,涵盖了Dubbo3的概念与架构、服务发现机制,以及如何在提供端实现和注册服务,消费端引用服务的基本流程,并提供了相应的Java代码示例和配置方法。
    参考Dubbo3官方文档做的学习笔记
    |
    Dubbo 应用服务中间件
    dubbo中文参考文档
    http://alibaba.github.io/dubbo-doc-static/User+Guide-zh.
    3190 0
    |
    8月前
    |
    Dubbo Java 应用服务中间件
    微服务学习 | Springboot整合Dubbo+Nacos实现RPC调用
    微服务学习 | Springboot整合Dubbo+Nacos实现RPC调用
    |
    3月前
    |
    Dubbo Java 应用服务中间件
    Spring Cloud Dubbo:微服务通信的高效解决方案
    【10月更文挑战第15天】随着信息技术的发展,微服务架构成为企业应用开发的主流。Spring Cloud Dubbo结合了Dubbo的高性能RPC和Spring Cloud的生态系统,提供高效、稳定的微服务通信解决方案。它支持多种通信协议,具备服务注册与发现、负载均衡及容错机制,简化了服务调用的复杂性,使开发者能更专注于业务逻辑的实现。
    85 2
    |
    5月前
    |
    Dubbo Java 应用服务中间件
    💥Spring Cloud Dubbo火爆来袭!微服务通信的终极利器,你知道它有多强大吗?🔥
    【8月更文挑战第29天】随着信息技术的发展,微服务架构成为企业应用开发的主流模式,而高效的微服务通信至关重要。Spring Cloud Dubbo通过整合Dubbo与Spring Cloud的优势,提供高性能RPC通信及丰富的生态支持,包括服务注册与发现、负载均衡和容错机制等,简化了服务调用管理并支持多种通信协议,提升了系统的可伸缩性和稳定性,成为微服务通信领域的优选方案。开发者仅需关注业务逻辑,而无需过多关心底层通信细节,使得Spring Cloud Dubbo在未来微服务开发中将更加受到青睐。
    94 0
    |
    2月前
    |
    Dubbo Cloud Native 应用服务中间件
    阿里云的 Dubbo 和 Nacos 深度整合,提供了高效的服务注册与发现、配置管理等关键功能,简化了微服务治理,提升了系统的灵活性和可靠性。
    在云原生时代,微服务架构成为主流。阿里云的 Dubbo 和 Nacos 深度整合,提供了高效的服务注册与发现、配置管理等关键功能,简化了微服务治理,提升了系统的灵活性和可靠性。示例代码展示了如何在项目中实现两者的整合,通过 Nacos 动态调整服务状态和配置,适应多变的业务需求。
    63 2
    |
    3月前
    |
    Dubbo Java 应用服务中间件
    Dubbo学习圣经:从入门到精通 Dubbo3.0 + SpringCloud Alibaba 微服务基础框架
    尼恩团队的15大技术圣经,旨在帮助开发者系统化、体系化地掌握核心技术,提升技术实力,从而在面试和工作中脱颖而出。本文介绍了如何使用Dubbo3.0与Spring Cloud Gateway进行整合,解决传统Dubbo架构缺乏HTTP入口的问题,实现高性能的微服务网关。
    |
    4月前
    |
    Dubbo 应用服务中间件 Apache
    Star 4w+,Apache Dubbo 3.3 全新发布,Triple X 领衔,开启微服务通信新时代
    在 Apache Dubbo 突破 4w Star 之际,Apache Dubbo 团队正式宣布,Dubbo 3.3 正式发布!作为全球领先的开源微服务框架,Dubbo 一直致力于为开发者提供高性能、可扩展且灵活的分布式服务解决方案。此次发布的 Dubbo 3.3,通过 Triple X 的全新升级,突破了以往局限,实现了对南北向与东西向流量的全面支持,并提升了对云原生架构的友好性。
    160 14
    |
    8月前
    |
    Dubbo Java 应用服务中间件
    阿里巴巴资深架构师深度解析微服务架构设计之SpringCloud+Dubbo
    软件架构是一个包含各种组织的系统组织,这些组件包括Web服务器,应用服务器,数据库,存储,通讯层),它们彼此或和环境存在关系。系统架构的目标是解决利益相关者的关注点。