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 文檔建設

  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

點擊此處,立即報名!

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章