You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@dubbo.apache.org by GitBox <gi...@apache.org> on 2021/06/20 13:40:32 UTC
[GitHub] [dubbo-go] LaurenceLiZhixin commented on a change in pull request #1269: Doc: Update README

LaurenceLiZhixin commented on a change in pull request #1269:
URL: https://github.com/apache/dubbo-go/pull/1269#discussion_r654937163



##########
File path: README_CN.md
##########
@@ -8,220 +8,64 @@
 
 ---
 
-Apache Dubbo Go 语言实现，架起java和go之间的桥梁，与 gRPC/Spring Cloud 生态互联互通，带领Java生态享受云原生时代的技术红利。
+[English 🇺🇸](./README.md)
 
-## 证书 ##
+Apache Dubbo Go 语言实现，架起 Java 和 Golang 之间的桥梁，与 gRPC/Spring Cloud 生态互联互通，带领 Java 生态享受云原生时代的技术红利。请访问我们的[官方网站](https://dubbogo.github.io)查看快速开始和文档。
 
-Apache License, Version 2.0
+## 架构
 
-## 发布日志 ##
+![dubbo go extend](https://dubbogo.github.io/img/doc/dubbo-go-arch.png)
 
-[v1.5.6 - 2021年4月8日](https://github.com/apache/dubbo-go/releases/tag/v1.5.6)
+Dubbo-go已经实现了Dubbo的大部分层级，包括协议层（protocol layer）、注册层（registry layer)）等等。在Dubbo-go中使用了拓展模块（extension module）以实现更灵活的系统架构，开发者可以根据层接口实现一个自定义的层，并在不改动源代码的前提下通过`extension.Set`方法将它应用到Dubbo-go中。
 
-[v1.5.5 - 2021年1月5日](https://github.com/apache/dubbo-go/releases/tag/v1.5.5)
+## 特性
 
-[v1.4.5 - 2020年11月18日](https://github.com/apache/dubbo-go/releases/tag/v1.4.5)
+Dubbo-go中已实现的特性：
 
-[v1.5.4 - 2020年11月1日](https://github.com/apache/dubbo-go/releases/tag/v1.5.4)
+- **角色**: Consumer, Provider
+- **传输协议**: HTTP, TCP
+- **序列化协议**: JsonRPC V2, Hessian V2, [Json for gRPC](https://github.com/apache/dubbo-go/pull/582), Protocol Buffers
+- **协议**: Dubbo, [Triple](https://github.com/dubbogo/triple), JsonRPC V2, [gRPC](https://github.com/apache/dubbo-go/pull/311), [RESTful](https://github.com/apache/dubbo-go/pull/352)
+- **路由器**: [Dubbo3 Router](https://github.com/apache/dubbo-go/pull/1187)
+- **注册中心**: ZooKeeper, [etcd](https://github.com/apache/dubbo-go/pull/148), [Nacos](https://github.com/apache/dubbo-go/pull/151), [Consul](https://github.com/apache/dubbo-go/pull/121), [K8s](https://github.com/apache/dubbo-go/pull/400)
+- **动态配置中心与服务治理配置器**: Zookeeper, [Apollo](https://github.com/apache/dubbo-go/pull/250), [Nacos](https://github.com/apache/dubbo-go/pull/357)
+- **集群策略**: Failover, [Failfast](https://github.com/apache/dubbo-go/pull/140), [Failsafe/Failback](https://github.com/apache/dubbo-go/pull/136), [Available](https://github.com/apache/dubbo-go/pull/155), [Broadcast](https://github.com/apache/dubbo-go/pull/158), [Forking](https://github.com/apache/dubbo-go/pull/161)
+- **负载均衡策略**: Random, [RoundRobin](https://github.com/apache/dubbo-go/pull/66), [LeastActive](https://github.com/apache/dubbo-go/pull/65), [ConsistentHash](https://github.com/apache/dubbo-go/pull/261)
+- **过滤器**: Echo Health Check, [Circuit Break and Service Downgrade](https://github.com/apache/dubbo-go/pull/133), [TokenFilter](https://github.com/apache/dubbo-go/pull/202), [AccessLogFilter](https://github.com/apache/dubbo-go/pull/214), [TpsLimitFilter](https://github.com/apache/dubbo-go/pull/237), [ExecuteLimitFilter](https://github.com/apache/dubbo-go/pull/246), [GenericServiceFilter](https://github.com/apache/dubbo-go/pull/291), [Auth/Sign](https://github.com/apache/dubbo-go/pull/323), [MetricsFilter](https://github.com/apache/dubbo-go/pull/342), [TracingFilter](https://github.com/apache/dubbo-go/pull/335)
+- **调用**: [Generic Invoke](https://github.com/apache/dubbo-go/pull/122)
+- **监控**: Opentracing API, [Prometheus](https://github.com/apache/dubbo-go/pull/342)
+- **Tracing**: [For JsonRPC](https://github.com/apache/dubbo-go/pull/335), [For Dubbo](https://github.com/apache/dubbo-go/pull/344), [For gRPC](https://github.com/apache/dubbo-go/pull/397)
+- **元数据中心**: [Nacos(Local)](https://github.com/apache/dubbo-go/pull/522), [ZooKeeper(Local)](https://github.com/apache/dubbo-go/pull/633), [etcd(Local)](https://github.com/apache/dubbo-go/blob/9a5990d9a9c3d5e6633c0d7d926c156416bcb931/metadata/report/etcd/report.go), [Consul(Local)](https://github.com/apache/dubbo-go/pull/633), [ZooKeeper(Remoting)](https://github.com/apache/dubbo-go/pull/1161)
+- **工具**: [Dubbo-go-cli](https://github.com/apache/dubbo-go/pull/818)
 
-[v1.5.3 - 2020年9月23日](https://github.com/apache/dubbo-go/releases/tag/v1.5.3)
+## 开始
 
-[v1.5.1 - 2020年8月23日](https://github.com/apache/dubbo-go/releases/tag/v1.5.1)
+### 安装 Dubbo-go v3
 
-[v1.5.0 - 2020年7月24日](https://github.com/apache/dubbo-go/releases/tag/v1.5.0)
-
-[v1.4.0 - 2020年3月17日](https://github.com/apache/dubbo-go/releases/tag/v1.4.0)
-
-[v1.3.0 - 2020年3月1日](https://github.com/apache/dubbo-go/releases/tag/v1.3.0)
-
-[v1.2.0 - 2019年11月15日](https://github.com/apache/dubbo-go/releases/tag/v1.2.0)
-
-[v1.1.0 - 2019年9月7日 捐献给Apache之后的第一次release](https://github.com/apache/dubbo-go/releases/tag/v1.1.0)
-
-[v1.0.0 - 2019年5月29日 兼容dubbo v2.6.5 版本](https://github.com/apache/dubbo-go/releases/tag/v1.0.0)
-
-## 工程架构 ##
-
-基于dubbo的extension模块和分层的代码设计(包括 protocol layer, registry layer, cluster layer, config 等等)。我们的目标是：你可以对这些分层接口进行新的实现，并通过调用 extension 模块的“ extension.SetXXX ”方法来覆盖 dubbo-go [同 go-for-apache-dubbo ]的默认实现，以完成自己的特殊需求而无需修改源代码。同时，欢迎你为社区贡献有用的拓展实现。
-
-![dubbo go extend](./doc/pic/arch/dubbo-go-ext.png)
-
-关于详细设计请阅读 [code layered design](https://github.com/apache/dubbo-go/wiki/dubbo-go-V1.0-design)
-
-## 功能列表 ##
-
-实现列表:
-
-- 角色端
-    * Consumer
-    * Provider
-
-- 传输协议
-    * HTTP
-    * TCP
-
-- 序列化协议
-    * JsonRPC V2
-    * Hessian V2
-    * [json for grpc](https://github.com/apache/dubbo-go/pull/582)
-    * protobuf
-
-- 协议
-    * Dubbo
-    * [Triple](https://github.com/dubbogo/triple)
-    * Jsonrpc2.0
-    * [gRPC](https://github.com/apache/dubbo-go/pull/311)
-    * [RESTful](https://github.com/apache/dubbo-go/pull/352)
-
-- 路由器
-    * [Dubbo3统一路由规则](https://github.com/apache/dubbo-go/pull/1187)
-
-- 注册中心
-    * ZooKeeper
-    * [etcd v3](https://github.com/apache/dubbo-go/pull/148)
-    * [nacos](https://github.com/apache/dubbo-go/pull/151)
-    * [consul](https://github.com/apache/dubbo-go/pull/121)
-    * [k8s](https://github.com/apache/dubbo-go/pull/400)
-
-- 动态配置中心与服务治理配置器
-    * Zookeeper
-    * [apollo](https://github.com/apache/dubbo-go/pull/250)
-    * [nacos](https://github.com/apache/dubbo-go/pull/357)
-
-- 集群策略
-    * Failover
-    * [Failfast](https://github.com/apache/dubbo-go/pull/140)
-    * [Failsafe/Failback](https://github.com/apache/dubbo-go/pull/136)
-    * [Available](https://github.com/apache/dubbo-go/pull/155)
-    * [Broadcast](https://github.com/apache/dubbo-go/pull/158)
-    * [Forking](https://github.com/apache/dubbo-go/pull/161)
-
-- 负载均衡策略
-    * Random
-    * [RoundRobin](https://github.com/apache/dubbo-go/pull/66)
-    * [LeastActive](https://github.com/apache/dubbo-go/pull/65)
-    * [ConsistentHash](https://github.com/apache/dubbo-go/pull/261)
-
-- 过滤器
-    * Echo Health Check
-    * [服务熔断&降级](https://github.com/apache/dubbo-go/pull/133)
-    * [TokenFilter](https://github.com/apache/dubbo-go/pull/202)
-    * [AccessLogFilter](https://github.com/apache/dubbo-go/pull/214)
-    * [TpsLimitFilter](https://github.com/apache/dubbo-go/pull/237)
-    * [ExecuteLimitFilter](https://github.com/apache/dubbo-go/pull/246)
-    * [GenericServiceFilter](https://github.com/apache/dubbo-go/pull/291)
-    * [Auth/Sign](https://github.com/apache/dubbo-go/pull/323)
-    * [Metrics filter](https://github.com/apache/dubbo-go/pull/342)
-    * [Tracing filter](https://github.com/apache/dubbo-go/pull/335)
-
-- 调用
-    * [泛化调用](https://github.com/apache/dubbo-go/pull/122)
-
-- 监控
-    * Opentracing API
-    * [Prometheus](https://github.com/apache/dubbo-go/pull/342)
-
-- Tracing
-    * [For jsonrpc](https://github.com/apache/dubbo-go/pull/335)
-    * [For dubbo](https://github.com/apache/dubbo-go/pull/344)
-    * [For grpc](https://github.com/apache/dubbo-go/pull/397)
-
-- 元数据中心
-    * [Nacos(Local)](https://github.com/apache/dubbo-go/pull/522)
-    * [Zookeeper(Local)](https://github.com/apache/dubbo-go/pull/633)
-    * [Etcd(Local)](https://github.com/apache/dubbo-go/blob/9a5990d9a9c3d5e6633c0d7d926c156416bcb931/metadata/report/etcd/report.go)
-    * [Consul(Local)](https://github.com/apache/dubbo-go/pull/633)
-    * [Zookeeper(Remoting)](https://github.com/apache/dubbo-go/pull/1161)
-
-- 工具箱
-    * [Dubbo-go-cli](https://github.com/apache/dubbo-go/pull/818)
-
-你可以通过访问 [roadmap](https://github.com/apache/dubbo-go/wiki/Roadmap) 知道更多关于 dubbo-go 的信息。
-
-![feature](./doc/pic/arch/dubbo-go-arch.png)
-
-## 文档
-
-请访问 [dubbo官方文档中关于 dubbo-go 的系列文档](http://dubbo.apache.org/zh/blog/) 或 [过往dubbo-go文档列表](http://alexstocks.github.io/html/dubbogo.html)。
-
-## 快速开始 ##
-
-[dubbo-samples/golang](https://github.com/apache/dubbo-go-samples)这个项目的事例展示了如何使用 dubbo-go 。请仔细阅读 [dubbo-samples/golang/README.md](https://github.com/apache/dubbo-go-samples/blob/master/README.md) 学习如何处理配置并编译程序。
-
-## 运行单测
-
-### 执行全部校验
-
-```bash
-make verify
-```
-
-### 校验许可证
-
-```bash
-make license
 ```
-
-### 执行单元测试
-
-```bash
-make test
+go get dubbo.apache.org/dubbo-go/v3
 ```
 
-## 编译
+### 下一步
 
-请移步 [dubbo-go-samples](https://github.com/apache/dubbo-go-samples)
+- [Dubbo-go 样例](https://github.com/apache/dubbo-go-samples): 该项目提供了一系列的样例，以展示Dubbo-go的每一项特性以及帮助你将Dubbo-go集成到你的系统中。
+- Dubbo-go 快速开始: [中文 🇨🇳](https://dubbogo.github.io/zh-cn/docs/user/preface/3.0_feature.html), [English 🇺🇸](https://dubbogo.github.io/en-us/docs/user/quick-start.html)

Review comment:
       这个中文链接是简介不是快速开始，建议改下




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@dubbo.apache.org
For additional commands, e-mail: notifications-help@dubbo.apache.org