dubbo-go icon indicating copy to clipboard operation
dubbo-go copied to clipboard

Dubbo Go 文档结构优化设想

Open AlbumenJ opened this issue 2 years ago • 4 comments

  • Preface
    • What is DubboGo
    • 概念体系(RPC 是什么、协议是什么、比如 Triple、治理是什么……)
    • 代码架构(设计大图)
    • DubboGo Samples
  • Quick Start
    • 安装环境(是否可以提供一键安装脚本,sh)
    • 完成一次 RPC 调用(基于 quickstart 默认的版本)
    • 完成一次 RPC 调用(自己定义接口的版本)
  • Learning Dubbo-Go
    • 开发服务
      • 了解 Dubbo-Go 应用模板
      • 注册中心
        • 了解注册中心
        • 搭建并使用 Nacos 注册中心
        • 搭建并使用 Zookeeper 注册中心
        • 搭建并使用 Polaris 注册中心
      • RPC 协议配置
        • 多协议支持情况
        • 如何配置多协议
        • 使用 Triple 协议时,如何回传异常
      • 异构体系互通
        • 与 gRPC 应用互通
        • 与 Java 应用跨语言互通
      • 自定义注入 Dubbo-Go 的配置
        • 配置中心是什么
        • 远程加载配置启动
        • 使用配置 API 启动应用
      • 高级特性
        • 上下文传递
        • 泛化调用
        • 容错
        • 分布式事务
    • 调试服务
      • 基于 grpc_cli 的服务测试
      • Others?
    • 部署服务
      • 生产部署的最佳实践介绍
      • Docker 镜像打包教程(包含必要的工具,如生命周期管理)
      • Kubernetes 部署教程
    • 治理服务
      • 服务状态监控
        • 基于 http metrics 的指标观测
        • 数据上报 Promethus 教程
        • 基于 Grafana 的可视化监控教程
        • Dubbo Go 日志管理
      • 全链路追踪
        • 基于 Jaeger 的链路追踪
        • 使用 OpenTelmentry 协议
        • 基于 Skywalking 的追踪
      • 健康检查
        • 基于 grpc 的检查
        • 启动时检查
        • K8s probe
      • 流量管理
        • 优雅上下线
        • 路由规则
        • 柔性服务
      • 限流
        • Dubbo Go 内置的限流使用教程
        • 基于 Sentinel 的限流教程
        • 基于 Polaris 的限流教程
      • 服务网格
        • 部署 istio 环境
        • istio 环境部署 Dubbo-Go 应用
        • 流量管理
        • 使用 Pixiu 网关接入 Ingress 流量
      • 高级特性
        • 服务超时配置
        • 应用级服务发现
        • 拦截器扩展
  • Source Code Interpretation
    • 网络协议
    • 注册中心
  • Reference

Note:原有示例整合入任务

http://alexstocks.github.io/html/dubbogo.html

AlbumenJ avatar Dec 10 '22 09:12 AlbumenJ

支持 目前 dubbo go 社区功能实现水平与文档水平严重脱钩,好的文档也是开源项目中必不可少的一个组成

debuginn avatar Dec 10 '22 10:12 debuginn

对文档感兴趣的同学可以添加下钉钉群:18090013512

zhaoyunxing92 avatar Dec 10 '22 12:12 zhaoyunxing92

1

jasondeng1997 avatar Dec 11 '22 10:12 jasondeng1997

支持 目前 dubbo go 社区功能实现水平与文档水平严重脱钩,好的文档也是开源项目中必不可少的一个组成

pls join us.

AlexStocks avatar Dec 11 '22 14:12 AlexStocks