[dubbo-go] branch 3.0 updated: docs: update style and out-of-date links in readme (#2079)

alexstocks Mon, 17 Oct 2022 01:12:20 -0700

This is an automated email from the ASF dual-hosted git repository.

alexstocks pushed a commit to branch 3.0
in repository https://gitbox.apache.org/repos/asf/dubbo-go.git



The following commit(s) were added to refs/heads/3.0 by this push:
     new d80ee9cf3 docs: update style and out-of-date links in readme (#2079)
d80ee9cf3 is described below

commit d80ee9cf37067e8e953c7ca71c0c8c535da6e1ac
Author: Xuewei Niu <[email protected]>
AuthorDate: Mon Oct 17 16:12:04 2022 +0800

    docs: update style and out-of-date links in readme (#2079)
    
    * docs: update style and out-of-date links in readme
    
    Signed-off-by: Xuewei Niu <[email protected]>
    
    * docs: fix typos
    
    Signed-off-by: Xuewei Niu <[email protected]>
    
    Signed-off-by: Xuewei Niu <[email protected]>
---
 README.md    | 29 +++++++++++++++--------------
 README_CN.md |  2 +-
 2 files changed, 16 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index a266fc466..5b7cbecc6 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)
+<img src="https://dubbo-go-pixiu.github.io/img/pixiu-dubbo-ecosystem.png"; 
height="400px" display="display: block, margin: auto" />
 
-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)
+<img src="https://dubbogo.github.io/img/devops.png"; height="300px" 
display="display: block, margin: auto" />
 
 - **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,10 @@ 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, 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 8405f1318..3cacb9aad 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 调用

[dubbo-go] branch 3.0 updated: docs: update style and out-of-date links in readme (#2079)

Reply via email to