Merge pull request #864 from provenceee/zone-router-doc

【doc】add zone router doc

docs/FAQ-zh.md

@@ -4,29 +4,29 @@
 
 ## Sermant 框架功能
 
-#### [启动参数appName是什么参数?](./user-guide/FAQ-zh.md#启动参数appName是什么参数?)
-#### [Sermant 提供哪些方面的服务治理插件?](./user-guide/FAQ-zh.md#Sermant提供哪些方面的服务治理插件?)
+#### [启动参数appName是什么参数?](./user-guide/FAQ-zh.md#启动参数appName是什么参数)
+#### [Sermant 提供哪些方面的服务治理插件?](./user-guide/FAQ-zh.md#Sermant提供哪些方面的服务治理插件)
 
 ## 插件
 
 ### 限流降级
 
-#### [关于业务场景的apiPath是如何定义的?](./user-guide/flowcontrol/FAQ.md#关于业务场景的apiPath是如何定义的)
-#### [如何确定配置规则生效](./user-guide/flowcontrol/FAQ.md#如何确定配置规则生效)
-#### [熔断策略未生效的可能原因](./user-guide/flowcontrol/FAQ.md#熔断策略未生效的可能原因)
-#### [隔离仓规则未生效的可能原因](./user-guide/flowcontrol/FAQ.md#隔离仓规则未生效的可能原因)
-#### [重试规则未生效的可能原因](./user-guide/flowcontrol/FAQ.md#重试规则未生效的可能原因)
-#### [启动报HttpHostConnectException异常的可能原因](./user-guide/flowcontrol/FAQ.md#启动报HttpHostConnectException异常的可能原因)
+#### [关于业务场景的apiPath是如何定义的?](./user-guide/flowcontrol/FAQ-zh.md#关于业务场景的apiPath是如何定义的)
+#### [如何确定配置规则生效](./user-guide/flowcontrol/FAQ-zh.md#如何确定配置规则生效)
+#### [熔断策略未生效的可能原因](./user-guide/flowcontrol/FAQ-zh.md#熔断策略未生效的可能原因)
+#### [隔离仓规则未生效的可能原因](./user-guide/flowcontrol/FAQ-zh.md#隔离仓规则未生效的可能原因)
+#### [重试规则未生效的可能原因](./user-guide/flowcontrol/FAQ-zh.md#重试规则未生效的可能原因)
+#### [启动报HttpHostConnectException异常的可能原因](./user-guide/flowcontrol/FAQ-zh.md#启动报HttpHostConnectException异常的可能原因)
 
 ### 服务注册
 
-#### [报错：No such extension org.apache.dubbo.registry.RegistryFactory by name sc](./user-guide/registry/FAQ.md#报错No-such-extension-orgapachedubboregistryRegistryFactory-by-name-sc)
-#### [报错：/sermant/master/v1/register error](./user-guide/registry/FAQ.md#报错sermantmasterv1register-error)
-#### [报错：Connection reset](./user-guide/registry/FAQ.md#报错Connection-reset)
-#### [报错：https protocol is not supported](./user-guide/registry/FAQ.md#报错https-protocol-is-not-supported)
-#### [报错：No such extension org.apache.dubbo.metadata.report.MetadataReportFactory by name sc](./user-guide/registry/FAQ.md#报错No-such-extension-orgapachedubbometadatareportMetadataReportFactory-by-name-sc)
-#### [报错：No registry config found or it's not a valid config](./user-guide/registry/FAQ.md#报错No-registry-config-found-or-its-not-a-valid-config)
-#### [插件配置中，enableSpringRegister/enableDubboRegister与openMigration之间的关系是什么？](./user-guide/registry/FAQ.md#插件配置中enableSpringRegisterenableDubboRegister与openMigration之间的关系是什么)
+#### [报错：No such extension org.apache.dubbo.registry.RegistryFactory by name sc](./user-guide/registry/FAQ-zh.md#报错No-such-extension-orgapachedubboregistryRegistryFactory-by-name-sc)
+#### [报错：/sermant/master/v1/register error](./user-guide/registry/FAQ-zh.md#报错sermantmasterv1register-error)
+#### [报错：Connection reset](./user-guide/registry/FAQ-zh.md#报错Connection-reset)
+#### [报错：https protocol is not supported](./user-guide/registry/FAQ-zh.md#报错https-protocol-is-not-supported)
+#### [报错：No such extension org.apache.dubbo.metadata.report.MetadataReportFactory by name sc](./user-guide/registry/FAQ-zh.md#报错No-such-extension-orgapachedubbometadatareportMetadataReportFactory-by-name-sc)
+#### [报错：No registry config found or it's not a valid config](./user-guide/registry/FAQ-zh.md#报错No-registry-config-found-or-its-not-a-valid-config)
+#### [插件配置中，enableSpringRegister/enableDubboRegister与openMigration之间的关系是什么？](./user-guide/registry/FAQ-zh.md#插件配置中enableSpringRegisterenableDubboRegister与openMigration之间的关系是什么)
 
 [返回**QuickStart**说明文档](./QuickStart-zh.md)
 

docs/FAQ.md

@@ -4,29 +4,29 @@
 
 ## About Sermant Framework
 
-#### [What does the input parameter “appName” mean？](./user-guide/FAQ.md#启动参数appName是什么参数?)
-#### [What kind of service governance plugins does Sermant provide?](./user-guide/FAQ.md#Sermant提供哪些方面的服务治理插件?)
+#### [What does the input parameter “appName” mean？](./user-guide/FAQ.md#What-does-the-input-parameter-appName-mean)
+#### [What kind of service governance plugins does Sermant provide?](./user-guide/FAQ.md#What-kind-of-service-governance-plugins-does-Sermant-provide)
 
 ## About Sermant Plugins
 
 ### Flow Control and Degradation
 
-#### [How to define "apiPath" for a business scenario?](./user-guide/flowcontrol/FAQ.md#关于业务场景的apiPath是如何定义的)
-#### [How to ensure that a configuration rule takes effect？](./user-guide/flowcontrol/FAQ.md#如何确定配置规则生效)
-#### [Possible reasons for why the circuit breaker policy did not take effect.](./user-guide/flowcontrol/FAQ.md#熔断策略未生效的可能原因)
-#### [Possible reasons for why isolation cabin rules did not take effect.](./user-guide/flowcontrol/FAQ.md#隔离仓规则未生效的可能原因)
-#### [Possible reasons for why the retry rules did not work.](./user-guide/flowcontrol/FAQ.md#重试规则未生效的可能原因)
-#### [Possible causes of HttpHostConnectException on startup.](./user-guide/flowcontrol/FAQ.md#启动报HttpHostConnectException异常的可能原因)
+#### [How to define "apiPath" for a business scenario?](./user-guide/flowcontrol/FAQ.md#How-Is-The-APIPath-Defined-In-The-Service-Scenario)
+#### [How to ensure that a configuration rule takes effect?](./user-guide/flowcontrol/FAQ.md#How-Do-I-Determine-Whether-a-Configuration-Rule-Takes-Effect)
+#### [Possible reasons for why the circuit breaker policy did not take effect.](./user-guide/flowcontrol/FAQ.md#Possible-Causes-For-The-Failure-Of-The-Circuit-Breaker-Policy-To-Take-Effect)
+#### [Possible reasons for why isolation cabin rules did not take effect.](./user-guide/flowcontrol/FAQ.md#Possible-Reasons-Why-The-Quarantine-Rule-Does-Not-Take-Effect)
+#### [Possible reasons for why the retry rules did not work.](./user-guide/flowcontrol/FAQ.md#Possible-Causes-For-The-Retry-Rule-Does-Not-Take-Effect)
+#### [Possible causes of HttpHostConnectException on startup.](./user-guide/flowcontrol/FAQ.md#Possible-Causes-Of-The-HttpHostConnectException-Error-Reported-During-Startup)
 
 ### Service Registration
 
-#### [Error: No such extension org.apache.dubbo.registry.RegistryFactory by name sc](./user-guide/registry/FAQ.md#报错No-such-extension-orgapachedubboregistryRegistryFactory-by-name-sc)
-#### [Error: /sermant/master/v1/register error](./user-guide/registry/FAQ.md#报错sermantmasterv1register-error)
-#### [Error: Connection reset](./user-guide/registry/FAQ.md#报错Connection-reset)
-#### [Error: https protocol is not supported](./user-guide/registry/FAQ.md#报错https-protocol-is-not-supported)
-#### [Error: No such extension org.apache.dubbo.metadata.report.MetadataReportFactory by name sc](./user-guide/registry/FAQ.md#报错No-such-extension-orgapachedubbometadatareportMetadataReportFactory-by-name-sc)
-#### [Error: No registry config found or it's not a valid config](./user-guide/registry/FAQ.md#报错No-registry-config-found-or-its-not-a-valid-config)
-#### [What is the relationship between "enableSpringRegister"/"enableDubboRegister" and "openMigration" in the plugin configuration?](./user-guide/registry/FAQ.md#插件配置中enableSpringRegisterenableDubboRegister与openMigration之间的关系是什么)
+#### [Exception: No such extension org.apache.dubbo.registry.RegistryFactory by name sc](./user-guide/registry/FAQ.md#Exception-No-such-extension-orgapachedubboregistryRegistryFactory-by-name-sc)
+#### [Exception: /sermant/master/v1/register error](./user-guide/registry/FAQ.md#Exception-sermantmasterv1register-error)
+#### [Exception: Connection reset](./user-guide/registry/FAQ.md#Exception-Connection-reset)
+#### [Exception: https protocol is not supported](./user-guide/registry/FAQ.md#Exception-https-protocol-is-not-supported)
+#### [Exception: No such extension org.apache.dubbo.metadata.report.MetadataReportFactory by name sc](./user-guide/registry/FAQ.md#Exception-No-such-extension-orgapachedubbometadatareportMetadataReportFactory-by-name-sc)
+#### [Exception: No registry config found or it's not a valid config](./user-guide/registry/FAQ.md#Exception-No-registry-config-found-or-its-not-a-valid-config)
+#### [What is the relationship between "enableSpringRegister"/"enableDubboRegister" and "openMigration" in the plugin configuration?](./user-guide/registry/FAQ.md#What-Is-The-Relationship-Between-Plugin-Configuration-enableSpringRegisterenableDubboRegister-And-openMigration)
 
 [Back to **QuickStart**](./QuickStart.md)
 

docs/user-guide/FAQ.md

@@ -2,7 +2,7 @@
 
 [简体中文](FAQ-zh.md) | [English](FAQ.md)
 
-## **What does the input parameter “appName” mean**
+## **What does the input parameter "appName" mean**
 
 - The `appName` represents the name of the host application. Multiple instances can have the same `appName` and different `instanceName`.
 

docs/user-guide/feature-list-zh.md

@@ -9,6 +9,7 @@
 |[服务双注册迁移](registry/spring-cloud-registry-migiration-zh.md)|实验|SpringBoot 1.5.x - 2.6.2 <br/> SpringCloud Edgware.SR2 - 2021.0.0<br>Dubbo 2.6.x-2.7.x|N/A|**目标注册中心**支持：servicecomb-service-center<br/>**SpringCloud原注册中心**支持：Eureka、Nacos、Zookeeper、Consul<br/>**Dubbo原注册中心**支持：Nacos、Zookeeper|-|
 |[负载均衡](loadbalancer/document-zh.md)|开发中|SpringBoot 1.5.x - 2.6.2 <br/> SpringCloud Edgware.SR2 - 2021.0.0|servicecomb-kie<br/>ZooKeeper|N/A|不同的版本所支持的负载均衡策略不同，具体请参考[负载均衡策略支持](loadbalancer/document.md#负载均衡策略支持一览)<br/>当前暂不支持网关应用|
 |[标签路由](router/document-zh.md)|实验|SpringBoot 1.5.x - 2.6.2 <br/>SpringCloud Edgware.SR2 - 2021.0.0<br/>Dubbo 2.6.x-2.7.x|servicecomb-kie|servicecomb-service-center|不支持异步调用<br>不支持混合框架（Dubbo调SpringCloud或者SpringCloud调Dubbo）做路由|
+|[区域路由](router/zone-router-zh.md)|实验|Dubbo 2.6.x-2.7.x|servicecomb-kie <br> ZooKeeper|servicecomb-service-center <br> ZooKeeper|-|
 |[优雅上下线](graceful/document-zh.md)|实验|SpringBoot 1.5.x - 2.6.2 <br/> SpringCloud Edgware.SR2 - 2021.0.0|servicecomb-kie<br/>ZooKeeper|N/A|该功能基于SpringCloud默认负载均衡实现，若实现自定义负载均衡，该能力将失效|
 |[动态配置](dynamic-config/document-zh.md)|开发中|SpringBoot 1.5.x - 2.6.2<br>spring-cloud-starter-alibaba-nacos-config 1.5.0.RELEASE+<br>spring-cloud-starter-zookeeper-config 1.2.0.RELEASE+|servicecomb-kie<br/>ZooKeeper|-||
 |[服务监控](server-monitor/document-zh.md)|开发中|ALL|N/A|N/A|-|

docs/user-guide/feature-list.md

@@ -9,6 +9,7 @@
 |[Service Dual Registration and Migration](registry/spring-cloud-registry-migiration.md)|Experimental Stage|SpringBoot 1.5.x - 2.6.2 <br/> SpringCloud Edgware.SR2 - 2021.0.0<br>Dubbo 2.6.x-2.7.x|N/A|**Target Registration Center** supported：servicecomb-service-center<br/>**Original Registration Center of SpringCloud** supported：Eureka、Nacos、Zookeeper、Consul<br/>**Original Registration Center of Dubbo** supported：Nacos、Zookeeper|-|
 |[Loadbalancer](loadbalancer/document.md)|In Development|SpringBoot 1.5.x - 2.6.2 <br/> SpringCloud Edgware.SR2 - 2021.0.0|servicecomb-kie<br/>ZooKeeper|N/A|Different versions support different load balancing policies. For details, refer to [Policies Supported in Loadbalance](loadbalancer/document.md#负载均衡策略支持一览)<br/> Gateway applications are not supported at present.|
 |[Tag Router](router/document.md)|Experimental Stage|SpringBoot 1.5.x - 2.6.2 <br/>SpringCloud Edgware.SR2 - 2021.0.0<br/>Dubbo 2.6.x-2.7.x|servicecomb-kie|servicecomb-service-center|Asynchronous invocation is not supported. <br />Hybrid frameworks (SpringCloud or Dubbo) are not supported for routing|
+|[Zone Router](router/zone-router.md)|Experimental Stage|Dubbo 2.6.x-2.7.x|servicecomb-kie <br> ZooKeeper|servicecomb-service-center <br> ZooKeeper|-|
 |[Graceful Online/Offline](graceful/document.md)|Experimental Stage|SpringBoot 1.5.x - 2.6.2 <br/> SpringCloud 
 Edgware.SR2 - 2021.0.0|servicecomb-kie<br/>ZooKeeper|N/A|This function is implemented based on the default loadbalance of SpringCloud. If user-defined loadbalance is implemented, this function won't work.|
 |[Dynamic Configuration](dynamic-config/document.md)|In Development|SpringBoot 1.5.x - 2.6.2<br>spring-cloud-starter-alibaba-nacos-config 1.5.0.RELEASE+<br>spring-cloud-starter-zookeeper-config 1.2.0.RELEASE+|servicecomb-kie<br/>ZooKeeper|-||

docs/user-guide/registry/FAQ.md

@@ -4,7 +4,7 @@
 
 This document describes frequently asked questions (FAQs) about using the [service registration plugin](../../../sermant-plugins/sermant-service-registry).
 
-## Exception：No Such Extension org.apache.dubbo.registry.RegistryFactory by name sc
+## Exception: No Such Extension org.apache.dubbo.registry.RegistryFactory by name sc
 
 As shown in the following figure:
 
@@ -26,7 +26,7 @@ The possible causes are as follows:
 
 - The configuration center address (dynamic.config.server_address) is incorrectly configured in the core configuration file, the configuration center is not started, or the network is disconnected. As a result, the host application fails to load the agent, and the No such extension org.apache.dubbo.registry.RegistryFactory by name sc reports an error.
 
-## Exception：/sermant/master/v1/register error
+## Exception: /sermant/master/v1/register error
 
 As shown in the following figure:
 
@@ -36,23 +36,23 @@ The cause is that the backend is not started or the configured address is incorr
 
 Note: This error does not affect the plugin registration process, but related errors may be reported.
 
-## Exception：Connection reset
+## Exception: Connection reset
 
 As shown in the following figure:
 
 ![Connection reset](../../binary-docs/registry-faq-5.png)
 
 Check whether the registration center address (servicecomb.service.address) and protocol (HTTP/HTTPS) in the plugin configuration (${agent_package_path}/agent/pluginPackage/service-registry/config/config.yaml) are correct.
 
-## Exception：https protocol is not supported
+## Exception: https protocol is not supported
 
 As shown in the following figure:
 
 ![https protocol is not supported](../../binary-docs/registry-faq-6.png)
 
 You need to enable ssl (servicecomb.service.sslEnabled) in the plugin configuration (${agent_package_path}/agent/pluginPackage/service-registry/config/config.yaml).
 
-## Exception：No such extension org.apache.dubbo.metadata.report.MetadataReportFactory by name sc
+## Exception: No such extension org.apache.dubbo.metadata.report.MetadataReportFactory by name sc
 
 As shown in the following figure:
 
@@ -76,7 +76,7 @@ dubbo:
 
 If protocol exists and is not set to sc, set protocol to sc or delete the protocol configuration.
 
-## Exception：No registry config found or it's not a valid config
+## Exception: No registry config found or it's not a valid config
 
 As shown in the following figure:
 

docs/user-guide/registry/spring-cloud-registry-migiration.md

@@ -4,7 +4,7 @@
 
 This document describes the migration capability of the [service registration plugin](../../../sermant-plugins/sermant-service-registry) based on the Spring Cloud framework registration center.
 
-Dubbo migration  referring [Dubbo Registry Migration](dubbo-registry-migiration.md)
+Dubbo migration referring [Dubbo Registry Migration](dubbo-registry-migiration.md)
 
 ## Function
 

docs/user-guide/router/document-zh.md

@@ -2,7 +2,9 @@
 
 [简体中文](document-zh.md) | [English](document.md)
 
-本文档主要介绍[标签路由插件](../../../sermant-plugins/sermant-router)的使用方法
+本文档主要介绍[标签路由插件](../../../sermant-plugins/sermant-router)的使用方法。
+
+区域路由见[区域路由](zone-router-zh.md)。
 
 ## 功能
 

docs/user-guide/router/document.md

@@ -4,6 +4,8 @@
 
 This document is used to introduce the usage of [tag router](../../../sermant-plugins/sermant-router)
 
+Zone Router referring [Zone Router](zone-router.md).
+
 ## Function
 
 In the case of multiple versions and instances of microservices, the routing between services is managed by configuring routing rules to achieve business purposes such as lossless upgrade and application dial test.
@@ -107,7 +109,7 @@ The parameters are described as follows:
 
 - Prerequisites [correctly packed Sermant](../../README.md)
 
-- Registration center using Huawei CSE, download [Local-CSE](https://support.huaweicloud.com/devg-cse/cse_devg_0036.html) ，解压后按照文档说明进行启动
+- Registration center using Huawei CSE, download [Local-CSE](https://support.huaweicloud.com/devg-cse/cse_devg_0036.html), unzip and follow the documentation to start.
 
 - Configuring Routing Rules