From 0c9d768bd32e1b5cb236acce0d52e5d5bf33fb1d Mon Sep 17 00:00:00 2001 From: Xuewei Niu Date: Mon, 17 Oct 2022 15:39:45 +0800 Subject: [PATCH 1/2] docs: update style and out-of-date links in readme Signed-off-by: Xuewei Niu --- README.md | 30 ++++++++++++++++-------------- README_CN.md | 2 +- 2 files changed, 17 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index a266fc466d..6cddbcfab4 100644 --- a/README.md +++ b/README.md @@ -10,21 +10,21 @@ [中文 🇨🇳](./README_CN.md) -Apache Dubbo-go, a Dubbo implementation written in Golang, is born to bridge the gap between Java/Dubbo and Go/X. Please visit our [Dubbo official website](https://dubbo.apache.org/zh/docs/languages/golang/) for the quick start and documentation. +Apache Dubbo-go, a Dubbo implementation written in Golang, is born to bridge the gap between Java/Dubbo and Go/X. Please visit our [Dubbo official website](https://dubbo.apache.org/zh/docs3-v2/golang-sdk/) for the quick start and documentation. -## RPC Invocation +## RPC invocation -![](https://dubbo-go-pixiu.github.io/img/pixiu-dubbo-ecosystem.png) + -Dubbo-go has supported many RPC protocol, like Triple, Dubbo JSONRPC, gRPC, HTTP, HTTP2. +Dubbo-go has supported many RPC protocols, like Triple, Dubbo JSONRPC, gRPC, HTTP, HTTP2. - Triple is the supported protocol of Dubbo3 ecology, and is gRPC extended protocol based on HTTP2, which is compatible with gRPC service.In other words, **on the basis of gRPC's reliable invocation, it adds Dubbo's service governance capability.** -- Dubbo protocol is tradition Dubbo ecology protocol, which is capitable with dubbo 2.x, and is a good choice for cross-language invocation between GO and Java old service. +- Dubbo protocol is tradition Dubbo ecology protocol, which is compatible with Dubbo 2.x, and is a good choice for cross-language invocation between GO and Java legacy service. - HTTP support：As you can see in the figure above, you can invoke Triple/Dubbo service using HTTP protocol through [dubbo-go-pixiu](https://github.com/apache/dubbo-go-pixiu) gateway. -## Service Governance Capability. +## Service governance capability -![](https://dubbogo.github.io/img/devops.png) + - **Registry**: Nacos, Zookeeper, ETCD, Polaris-mesh, Consul. - **ConfigCenter**: Nacos, Zookeeper @@ -43,7 +43,7 @@ Dubbo-go has supported many RPC protocol, like Triple, Dubbo JSONRPC, gRPC, HTTP - [Dubbo-go Benchmark](https://github.com/dubbogo/dubbo-go-benchmark) - [Dubbo-go Wiki](https://github.com/apache/dubbo-go/wiki) -## tools +## Tools * [imports-formatter](https://github.com/dubbogo/tools/blob/master/cmd/imports-formatter/main.go) formatting dubbo-go project import code block. * [dubbo-go-cli](https://github.com/dubbogo/tools/blob/master/cmd/dubbogo-cli/main.go) dubbo-go command line tools, by which you can define your own request pkg and gets rsp struct of your server, test your service as telnet and generate hessian.POJO register method body. @@ -54,7 +54,7 @@ Dubbo-go has supported many RPC protocol, like Triple, Dubbo JSONRPC, gRPC, HTTP If you want to know more about dubbogo tools, please visit https://github.com/apache/dubbo-go/blob/master/dubbogo-cli and read its readme carefully. -## Intellij Plugin +## Intellij plugin * Windows: File > Settings > Plugins > Browse repositories... > Search for "Dubbo Go" > Install Plugin * MacOS: Preferences > Settings > Plugins > Browse repositories... > Search for "Dubbo Go" > Install Plugin @@ -63,19 +63,19 @@ If you want to know more about dubbogo tools, please visit https://github.com/ap * From official jetbrains store from download -### Feature +### Features | Feature | IDEA | GoLand | |:------------------:|:----:|:------:| | Hessian2 Generator | ✅️ | ✅️ | | New Project/Module | ✅️ | ✅️ | -#### Project/Module Template +### Project/module templates | Project/Module Template | Progress | |:-----------------------:|:--------:| | Sample | ✅️ | | Empty Project | ✅️ | -##### Empty Project Template Middleware +### Empty project template middleware | Middleware | Module | Support | |:------------:|:-------------------------------------:|:-------:| | Web Service | [Gin](github.com/gin-gonic/gin) | ✅️ | @@ -83,9 +83,11 @@ If you want to know more about dubbogo tools, please visit https://github.com/ap | Database | [Gorm](gorm.io/gorm) | ✅️ | -If you want to know more about dubbogo Intellij Plugin, please visit [https://gitee.com/changeden/intellij-plugin-dubbo-go-generator](https://gitee.com/changeden/intellij-plugin-dubbo-go-generator) and read its readme carefully. +If you want to know more about the Intellij Plugin for Dubbo-go, please you may +refer +to[https://gitee.com/changeden/intellij-plugin-dubbo-go-generator](https://gitee.com/changeden/intellij-plugin-dubbo-go-generator). -## Dubbo-go ecosystem +## Ecosystem * [Dubbo Ecosystem Entry](https://github.com/apache?utf8=%E2%9C%93&q=dubbo&type=&language=) - A GitHub group `dubbo` to gather all Dubbo relevant projects not appropriate in [apache](https://github.com/apache) group yet. * [dubbo-go-pixiu](https://github.com/apache/dubbo-go-pixiu) - A dynamic, high-performance API gateway solution for Dubbo and Http services. diff --git a/README_CN.md b/README_CN.md index 8405f13182..3cacb9aadf 100644 --- a/README_CN.md +++ b/README_CN.md @@ -10,7 +10,7 @@ [English 🇺🇸](./README.md) -Apache Dubbo Go 语言实现，架起 Java 和 Golang 之间的桥梁，与 gRPC/Dubbo/SpringCloud 生态互联互通，带领 Java 生态享受云原生时代的技术红利。请访问[Dubbo 官网](https://dubbo.apache.org/zh/docs/languages/golang/)查看快速开始和文档。 +Apache Dubbo Go 语言实现，架起 Java 和 Golang 之间的桥梁，与 gRPC/Dubbo/SpringCloud 生态互联互通，带领 Java 生态享受云原生时代的技术红利。请访问[Dubbo 官网](https://dubbo.apache.org/zh/docs3-v2/golang-sdk/)查看快速开始和文档。 ## RPC 调用 From f99f46a62bb368a979347cee154251cbb2c08c72 Mon Sep 17 00:00:00 2001 From: Xuewei Niu Date: Mon, 17 Oct 2022 15:50:15 +0800 Subject: [PATCH 2/2] docs: fix typos Signed-off-by: Xuewei Niu --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6cddbcfab4..5b7cbecc65 100644 --- a/README.md +++ b/README.md @@ -69,13 +69,13 @@ If you want to know more about dubbogo tools, please visit https://github.com/ap | Hessian2 Generator | ✅️ | ✅️ | | New Project/Module | ✅️ | ✅️ | -### Project/module templates +#### Project/module templates | Project/Module Template | Progress | |:-----------------------:|:--------:| | Sample | ✅️ | | Empty Project | ✅️ | -### Empty project template middleware +##### Empty project template middleware | Middleware | Module | Support | |:------------:|:-------------------------------------:|:-------:| | Web Service | [Gin](github.com/gin-gonic/gin) | ✅️ | @@ -83,9 +83,8 @@ If you want to know more about dubbogo tools, please visit https://github.com/ap | Database | [Gorm](gorm.io/gorm) | ✅️ | -If you want to know more about the Intellij Plugin for Dubbo-go, please you may -refer -to[https://gitee.com/changeden/intellij-plugin-dubbo-go-generator](https://gitee.com/changeden/intellij-plugin-dubbo-go-generator). +If you want to know more about the Intellij Plugin for Dubbo-go, you may +refer to [https://gitee.com/changeden/intellij-plugin-dubbo-go-generator](https://gitee.com/changeden/intellij-plugin-dubbo-go-generator). ## Ecosystem