From 51c3660f471b72c6f75b41b3e384946ce71da962 Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 14:42:42 +0800
Subject: [PATCH 01/19] Update README.md

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 99c436bd..5f0bf1e7 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,6 @@ See [Document Summary](docs/en_us/SUMMARY.md)
 
 BFE is under the Apache 2.0 license. See the [LICENSE](https://github.com/bfenetworks/ingress-bfe/blob/master/LICENSE) file for details
 
-[Kubernetes Ingress Controller]: https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/ "Kubernetes"
+[Ingress Controller]: https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/ "Kubernetes"
 [Ingress]: https://kubernetes.io/docs/concepts/services-networking/ingress/ "Kubernetes"
 [BFE]: https://github.com/bfenetworks/bfe "Github"

From 999f82c06c47ee3a3b58a37a31b252717308d5f7 Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 14:46:50 +0800
Subject: [PATCH 02/19] Update README-CN.md

---
 README-CN.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README-CN.md b/README-CN.md
index c43cec36..efafda10 100644
--- a/README-CN.md
+++ b/README-CN.md
@@ -13,9 +13,9 @@ BFE Ingress Controller 为基于 [BFE][] 实现的[Kubernetes Ingress Controller
 详见[文档列表](docs/zh_cn/SUMMARY.md)
 
 ## 参与贡献
-- 请首先在 issue 列表中创建一个 issue
+- 请首先在 [issue 列表]((https://github.com/bfenetworks/ingress-bfe/issues) 中创建一个 issue
 - 如有必要，请联系项目维护者/负责人进行进一步讨论
-- 请遵循 Golang 编程规范
+- 请遵循 [Golang 编程规范](https://github.com/golang/go/wiki/Style)
 
 ## 社区交流
 

From 00d7957a7788791ed41d48078f7f575f80393f10 Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 15:07:24 +0800
Subject: [PATCH 03/19] Update deployment.md

---
 docs/en_us/deployment.md | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/docs/en_us/deployment.md b/docs/en_us/deployment.md
index bd939425..6a9cc5c0 100644
--- a/docs/en_us/deployment.md
+++ b/docs/en_us/deployment.md
@@ -8,7 +8,7 @@
     kubectl apply -f controller.yaml
     ```
     - Config file example: [controller.yaml](../../examples/controller.yaml)
-        - This config file uses [BFE Ingress Controller]:latest image on Docker Hub. If you want to use your customized version of the image, edit the config file to specify it.
+        - This config file uses [BFE Ingress Controller latest image on Docker Hub](https://hub.docker.com/r/bfenetworks/bfe-ingress-controller). If you want to use your customized version of the image, edit the config file to specify it.
         - Or you can run `make docker` in root folder of this project to create your own local image and use it.
 
 * To config role-based access control:
@@ -17,7 +17,7 @@
     ```
 
    - Config file example: [rbac.yaml](../../examples/rbac.yaml)
-   - See detailed instructions in [Role-Based Access Control](rbac.md)。
+   - See detailed instructions in [Role-Based Access Control](rbac.md)
 
 ## Test
 
@@ -38,6 +38,4 @@
    
    - Refer to [ingress.yaml](../../examples/ingress.yaml) for basic Ingress configuration.
    
-   - More Ingress configuration options that BFE Ingress Controller support, refer to [Configuration](SUMMARY.md).
-
-[BFE Ingress Controller]: https://hub.docker.com/r/bfenetworks/bfe-ingress-controller
\ No newline at end of file
+   - Refer to [Summary](SUMMARY.md) for more Ingress configuration options that BFE Ingress Controller support.

From 5f5832fd761afd9176ffab31f8f27eee4e66ba8e Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 15:10:53 +0800
Subject: [PATCH 04/19] Update deployment.md

---
 docs/zh_cn/deployment.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/zh_cn/deployment.md b/docs/zh_cn/deployment.md
index dec7de05..ec3a1db0 100644
--- a/docs/zh_cn/deployment.md
+++ b/docs/zh_cn/deployment.md
@@ -6,7 +6,7 @@
     kubectl apply -f controller.yaml
     ```
     - 配置文件示例[controller.yaml](../../examples/controller.yaml)
-        - 配置文件中使用了Docker Hub 上的[BFE Ingress Controller]:latest镜像。如需使用指定版本的镜像，修改配置文件，指定镜像版本。
+        - 配置文件中使用了[Docker Hub 上的BFE Ingress Controller的最新镜像](https://hub.docker.com/r/bfenetworks/bfe-ingress-controller)。如需使用指定版本的镜像，修改配置文件，指定镜像版本。
         - 也可在项目根目录下执行`make docker`，创建自己的本地镜像。
 
 * 配置所需权限
@@ -32,4 +32,4 @@
    - 基本的Ingess配置可参考 [ingress.yaml](../../examples/ingress.yaml)。
    - 更多的BFE Ingress Controller所支持的Ingress配置，可参考配置[相关文档](SUMMARY.md)。
 
-[BFE Ingress Controller]: https://hub.docker.com/r/bfenetworks/bfe-ingress-controller
+

From 37fead39560d4b0c5e5f5b62415aae746ce2a228 Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 15:24:24 +0800
Subject: [PATCH 05/19] Update rbac.md

---
 docs/en_us/rbac.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/docs/en_us/rbac.md b/docs/en_us/rbac.md
index c1f41987..69c1ea85 100644
--- a/docs/en_us/rbac.md
+++ b/docs/en_us/rbac.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-This document describe how to deploy BFE Ingress Controller in a environment with RBAC enabled.
+This document describe how to deploy BFE Ingress Controller in an environment with RBAC enabled.
 
 Kubernetes use [Role-based access control](https://kubernetes.io/docs/reference/access-authn-authz/rbac/), and define below objects：
 
@@ -10,11 +10,11 @@ Kubernetes use [Role-based access control](https://kubernetes.io/docs/reference/
   - `ClusterRole` - to define permissions of a role which is cluster-wide
   - `Role` - to define permissions of a role which belongs to specific namespace
 
-- Define role binding, to grant permissions defined in a role to a user or set of users:
+- Define 'role binding', to grant permissions defined in a role to a user or set of users:
   - `ClusterRoleBinding` , to grant permissions defined in `ClusterRole` to user
   - `RoleBinding` , to grant permissions defined in `Role` to user
 
-To deploy a BFE Ingress Controller instance in a environment with RBAC enabled, use the `ServiceAccount` that binded to a `ClusterRole`, which has been granted with all permissions BFE Ingress Controller required.
+To deploy a BFE Ingress Controller instance in an environment with RBAC enabled, use the `ServiceAccount` that binded to a `ClusterRole`, which has been granted with all permissions BFE Ingress Controller required.
 
 ## Minimum permission set
 
@@ -42,14 +42,14 @@ In [controller.yaml](../../examples/controller.yaml) ：
 - define a `ServiceAccount` ,
   - name it as `bfe-ingress-controller`
 - define a BFE Ingress Controller instance deployment
-  - Instance deployed should liked to  ServiceAccount `bfe-ingress-controller`
+  - Instance deployed should be linked to ServiceAccount `bfe-ingress-controller`
 
 ### Define ClusterRole
 
 In [rbac.yaml](../../examples/rbac.yaml) ：
 - define a `ClusterRole`,
   - name it as `bfe-ingress-controller`
-  - grant below cluster-wide permissions to it：
+  - grant cluster-wide permissions below to it：
 
     ```yaml
     services, endpoints, secrets, namespaces: get, list, watch

From dee70325f4bf1bbe299ed1aaf3c293cc096f16ef Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 16:39:27 +0800
Subject: [PATCH 06/19] Update basic.md

---
 docs/en_us/ingress/basic.md | 30 ++++++++++++++----------------
 1 file changed, 14 insertions(+), 16 deletions(-)

diff --git a/docs/en_us/ingress/basic.md b/docs/en_us/ingress/basic.md
index 0e9ada8c..d7057aff 100644
--- a/docs/en_us/ingress/basic.md
+++ b/docs/en_us/ingress/basic.md
@@ -1,7 +1,7 @@
 # Configuration Guide
 
 ## Introduction
-Configure Ingress resources to define route of accessing Services in Kubernetes cluster from outside the cluster. For more information about Ingress, refer to [Ingress][] .
+Configure Ingress resources to define routes for accessing Services in Kubernetes cluster from outside of the cluster. For more information about Ingress, please refer to [Ingress][] .
 
 Refer to [ingress.yaml](../../examples/ingress.yaml) when configuring Ingress resources in yaml files.
 
@@ -25,14 +25,12 @@ spec:
             port:
               number: 80
 ```
-Above example defined a Ingress resource, and
+Above example defines a Ingress resource, and
 
-- set `kubernetes.io/ingress.class` to `bfe`, means this Ingress will be handled by BFE Ingress Controller
+- sets `kubernetes.io/ingress.class` to `bfe`, means this Ingress will be handled by BFE Ingress Controller
 
--  defines a simple route rule：
-  A requests will be forwarded to port 80 of Service `whoami`, if it matches both below conditions:
+- defines a simple route rule. A request will be forwarded to port 80 of Service `whoami`, if it matches both below conditions:
   - hostname is `whoami.com` 
-
   - path has prefix `/testpath`
 
 ### Complicated example
@@ -70,9 +68,9 @@ spec:
             port:
               number: 80
 ```
-Above Ingress resource defines 2 advanced route rule, and configure TLS certificate for `foo.com`. Rules in annotations are BFE defined rule options.
+Above Ingress resource defines 2 advanced route rules, and configure TLS certificate for `foo.com`. Rule options supported by BFE are defined with annotations.
 
-- Route rule 1：a request will be forwarded to port 80 of service`foo` , if it matches all below conditions. And Service `foo` is composed of two Services: `sub-foo1` and `sub-foo2`, serving 80% and 20% of requests to `foo`. See [Load balancing between Services](load-balance.md).
+- Route rule 1：a request will be forwarded to port 80 of service`foo` , if it matches all below conditions. Service `foo` is composed of two Services: `sub-foo1` and `sub-foo2`, serving 80% and 20% of total requests to `foo`. See [Load balancing between Services](load-balance.md).
 
     - hostname is `foo.com`
     - path has prefix `/foo`
@@ -109,9 +107,9 @@ BFE Ingress Controller support below pathType：
 
 BFE Ingress Controller supports advanced conditions by configuring `annotation`.
 
-Advanced conditions is shared in a Ingress resource. So all the rules in the same Ingress resource will be restrained by advanced conditions, if configured.
+Advanced conditions are shared in a Ingress resource. So all the rules in the same Ingress resource will be restrained by advanced conditions, if configured.
 
-Currently BFE Ingress Controller support two advanced conditions types: cookie and header.
+Currently BFE Ingress Controller supports two types of advanced condition: cookie and header.
 
 #### Cookie
 
@@ -122,7 +120,7 @@ bfe.ingress.kubernetes.io/router.cookie: "key: value"
 
 Explanation：
 
-Requests containing a cookie with name=`key` and value=`value` are considered match this condition.
+Requests containing a cookie with name=`key` and value=`value` are considered as matching this condition.
 
 #### Header      
 
@@ -140,7 +138,7 @@ Requests containing a header with name=`key` and value=`value` are considered ma
 
 - In a Ingress resource, for each advanced condition type, no more than one `Annotation` can be configured.
   
-- If more than one `Annotation` of the same advanced condition type are configured in the same Ingress resource, the bottom one takes effect.
+- If more than one `Annotation`s of the same advanced condition type are configured in the same Ingress resource, the last one takes effect.
   
     ```yaml
     # example
@@ -151,7 +149,7 @@ Requests containing a header with name=`key` and value=`value` are considered ma
 
 ## Ingress class
 
-BFE Ingress Controller support user to configure ingress class in two ways:
+BFE Ingress Controller supports user to configure ingress class in two ways:
 
 ### Set in annotations
 
@@ -164,7 +162,7 @@ Set `kubernetes.io/ingress.class` in annotations of Ingress. Default value is `b
 
 ### Set in IngressClass
 
-For k8s vesions from 1.18, set  controller to`bfe-networks.com/ingress-controller` in IngressClass of K8S Cluster. Example:
+For K8S vesions from 1.18, set controller to `bfe-networks.com/ingress-controller` in IngressClass of K8S Cluster. Example:
 
 ```yaml
 apiVersion: networking.k8s.io/v1beta1
@@ -186,10 +184,10 @@ spec:
 ...
 ```
 
-For information about  IngressClass, refer to [IngressClass]。
+For information about IngressClass, refer to [IngressClass]
 
 
 [Ingress]: https://kubernetes.io/docs/concepts/services-networking/ingress/#what-is-ingress
 [pathType]: https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types
 [hostname-wildcards]: https://kubernetes.io/docs/concepts/services-networking/ingress/#hostname-wildcards
-
+[IngressClass]: https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#extended-configuration-with-ingress-classes

From 3bc04a954472cb5423ff07d2872792977445105f Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 17:15:09 +0800
Subject: [PATCH 07/19] Update validate-state.md

---
 docs/zh_cn/ingress/validate-state.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/zh_cn/ingress/validate-state.md b/docs/zh_cn/ingress/validate-state.md
index 27059d43..4684c2a2 100644
--- a/docs/zh_cn/ingress/validate-state.md
+++ b/docs/zh_cn/ingress/validate-state.md
@@ -9,8 +9,8 @@ Ingress配置的合法性检查是一个异步过程，检查结果在配置生
 ```yaml
 #bfe.ingress.kubernetes.io/bfe-ingress-status为BFE-Ingress预留的Annotation key，
 #用于BFE-Ingress反馈生效状态
-# status; 表示当前ingress是否合法， 取值为：success -> ingress合法， error -> ingress不合法
-# message; 当ingress不合法的情况下，message记录错误详细原因。
+# status: 表示当前ingress是否合法， 取值为：success -> ingress合法， error -> ingress不合法
+# message: 当ingress不合法的情况下，message记录错误详细原因。
 bfe.ingress.kubernetes.io/bfe-ingress-status: {"status": "", "message": ""}
 ```
 ## 示例
@@ -91,4 +91,4 @@ spec:
             backend:
               serviceName: service2
               servicePort: 80
-```
\ No newline at end of file
+```

From 3e1b5d991ceed9cd4a84ef9926a46977e56975c5 Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 17:20:47 +0800
Subject: [PATCH 08/19] Update validate-state.md

---
 docs/zh_cn/ingress/validate-state.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/zh_cn/ingress/validate-state.md b/docs/zh_cn/ingress/validate-state.md
index 4684c2a2..00d03870 100644
--- a/docs/zh_cn/ingress/validate-state.md
+++ b/docs/zh_cn/ingress/validate-state.md
@@ -53,7 +53,7 @@ spec:
               serviceName: service2
               servicePort: 80
 ```
-根据[路由冲突](conflict.md)时的配置规则，`Ingress1`将生效，而`Ingress2`将被忽略。状态回写反馈后，`Ingress1`的状态为success，而`Ingress2`的状态为fail。
+根据[路由冲突处理原则](conflict.md)，`Ingress1`将生效，而`Ingress2`将被忽略。状态回写反馈后，`Ingress1`的状态为success，而`Ingress2`的状态为fail。
 ```yaml
 kind: Ingress
 apiVersion: networking.k8s.io/v1beta1

From 18fe56cd4232a0fe7a48b4d204ba7749f87b1030 Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 17:23:09 +0800
Subject: [PATCH 09/19] Update validate-state.md

---
 docs/en_us/ingress/validate-state.md | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/docs/en_us/ingress/validate-state.md b/docs/en_us/ingress/validate-state.md
index 02efdac6..4aa7a25e 100644
--- a/docs/en_us/ingress/validate-state.md
+++ b/docs/en_us/ingress/validate-state.md
@@ -1,22 +1,22 @@
-# Validate State
+# Ingress status
 
-## Validate state response
-Validating the Ingress config is an async process and the result can only be returned after resources applied.
+## Feedback for ingress status
+The validation of the Ingress configuration is an asynchronous process. The status can only be returned after the configuation has taken effect.
 
-In order to response the result of whether the Ingress takes effect, BFE Ingress Controller will write the validate state of the Ingress back to its annotations. 
+In order to provide feedback for ingress status, BFE Ingress Controller will write status back to its annotations. 
 
-**BFE Ingress Controller defines the annotation for validate state as follow:**
+**BFE Ingress Controller defines the annotation for status as follow:**
 
 ```yaml
-#bfe.ingress.kubernetes.io/bfe-ingress-status is the reserved Annotation key of BFE Ingress Controller，
-#used for validate state response
-# status; indicate if this ingress is valid, value can be: success -> ingress is valid and takes effect， error -> ingress is not valid
-# message; if ingress is not valid, error messages will be recoreded
+#bfe.ingress.kubernetes.io/bfe-ingress-status is the reserved Annotation key of BFE Ingress Controller
+#used for status feedback. 
+# status: success -> ingress is valid, error -> ingress is invalid.
+# message: if ingress is invalid, error messages will be recorded
 bfe.ingress.kubernetes.io/bfe-ingress-status: {"status": "", "message": ""}
 ```
 ## Example
 
-Below example shows the validate state response of two ingress with route rules conflict
+The following example shows the status of two ingresses with route rules conflict.
 `Ingress1` and `Ingress2` have one identical route rule (`Host:example.net, Path:/bar`)
 
 ```yaml
@@ -54,7 +54,7 @@ spec:
               serviceName: service2
               servicePort: 80
 ```
-According to conflict handling principle for [route rule conflict](conflict.md), `Ingress1` will take effect and `Ingress2` will be ignored. After validate state responsed, `status` of `Ingress1` will be "success" and for `Ingress2` it will be "fail".
+According to [principles of handling route rule conflict](conflict.md), `Ingress1` will take effect and `Ingress2` will be ignored. After the status is returned, `status` of `Ingress1` will be "success" and status of `Ingress2` it will be "fail".
 ```yaml
 kind: Ingress
 apiVersion: networking.k8s.io/v1beta1
@@ -92,4 +92,4 @@ spec:
             backend:
               serviceName: service2
               servicePort: 80
-```
\ No newline at end of file
+```

From 98c967c79a3d26ca4d254ae5890fa5f546d27865 Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 17:25:50 +0800
Subject: [PATCH 10/19] Update SUMMARY.md

---
 docs/en_us/SUMMARY.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/en_us/SUMMARY.md b/docs/en_us/SUMMARY.md
index f761f376..16997db4 100644
--- a/docs/en_us/SUMMARY.md
+++ b/docs/en_us/SUMMARY.md
@@ -6,9 +6,9 @@
     * [Role-Based Access Control (RBAC)](rbac.md)
 * Configuration
     * [Configuration Guide](ingress/basic.md)
-    * [Validate State](ingress/validate-state.md)
+    * [Ingress Status](ingress/validate-state.md)
     * [Priority of Route Rules](ingress/priority.md)
-    * [Route Rule Conflicts](ingress/conflict.md)
+    * [Principles of Handling Route Rule Conflicts](ingress/conflict.md)
     * [TLS  Configuration](ingress/tls.md)
     * [Load Balance](ingress/load-balance.md)
 * Configuration Examples

From 4479c7e154d8179ff452b4c6f4e1555c241a1a6f Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 17:42:12 +0800
Subject: [PATCH 11/19] Update conflict.md

---
 docs/en_us/ingress/conflict.md | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/docs/en_us/ingress/conflict.md b/docs/en_us/ingress/conflict.md
index 3d37e6d9..6db823ea 100644
--- a/docs/en_us/ingress/conflict.md
+++ b/docs/en_us/ingress/conflict.md
@@ -1,15 +1,15 @@
 # Route Rule Conflict
 
 ## Definition
-If Ingress configuration will create Ingress resources containing a same Ingress rule (host, path and advanced conditions are all the same), a route rule conflict happens. 
+If Ingress configuration is created with Ingress resources containing the same Ingress rule (host, path and advanced conditions are all the same), a route rule conflict happens. 
 
 ## Conflict handling: first-created-resource-win principle
 
 For those Ingress resources with route rule conflict, BFE Ingress Controller will follow first-created-resource-win principle and only takes the first created Ingress resource as valid.  
 
-Route rule conflicts within a namespace or among different namespaces will both follow this principle.
+This principle will be followed when route rule conflict happens within a namespace or among different namespaces.
 
-For those Ingress resources that not taken as valid by BFE Ingress Controller due to route rule conflict, related error messages will be writen to its annotation, see [Validate State](validate-state.md) `annotations`.
+For those Ingress resources invalid due to route rule conflict, error messages will be written to its annotation, see [Ingress Status](validate-state.md).
 
 ## Example
 
@@ -51,12 +51,12 @@ spec:
           servicePort: 80
 
 ```
-In above config, ingress-A and ingress-B have conflict, and ingress-A is created before ingress-B. So only ingress-A will been created and take effect.
+In above configuration, there is conflict between ingress-A and ingress-B, and ingress-A is created before ingress-B. So only ingress-A will been created and take effect.
 
-## Validate state writeback
-If a Ingress resource is ignored (not take effect) due to route rule conflict, after validate state writeback, the `status` of validate state `annotation` will be set as “fail”, and `message` will tell which Ingres resource it conflict with.
+## Ingress status feedback
+If a Ingress resource is ignored (not take effect) due to route rule conflict, after the ingress status is written back, the `status` in `annotation` will be set as “fail”, and `message` will tell which Ingress resource it has conflict with.
 
-In previous example, validate state `annotation` will be like:
+In previous example, `annotation` for ingress status will be like:
 
 
 ```yaml
@@ -66,5 +66,5 @@ metadata:
     	{"status": "fail", "message": "conflict with production/ingress-A"}
 ```
 
-For more information about validate state, refer to [Validate state](validate-state.md)。
+For more information about ingress status, refer to [ingress status](validate-state.md)。
 

From 63f01ed9bd1576d65914865ead6719d63123ba9a Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 17:51:38 +0800
Subject: [PATCH 12/19] Update priority.md

---
 docs/en_us/ingress/priority.md | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/docs/en_us/ingress/priority.md b/docs/en_us/ingress/priority.md
index e8d4ebb1..5bd46c0c 100644
--- a/docs/en_us/ingress/priority.md
+++ b/docs/en_us/ingress/priority.md
@@ -1,10 +1,10 @@
 # Priority of route rules
 If a request matches multiple ingress rules, BFE Ingress Controller will decide which rule will be hit according to below strategies:
 
--  Compares the hostname and select the rule with more precise hostname；
--  If hostname is identical, select the rule with more precise path；
+-  Compare the hostname and select the rule with more precise hostname;
+-  If hostname is identical, select the rule with more precise path;
 -  If both hostname and path are identical, select the rule with more matching advanced conditions;
--  If all the above criteria are the same, select the rule which matches an advanced condition of higher priority
+-  If all the above rules fails, select the rule which matches an advanced condition of higher priority
    - in advanced match condition, Cookie condition has higher priority than Header condition；
 
 ## Examples
@@ -44,7 +44,7 @@ spec:
               serviceName: service2
               servicePort: 80
 ```
-In above example, for requests generated by `curl "http://example.net/bar"`, rule in `host_priority1` will be hit
+In above example, for requests generated by `curl "http://example.net/bar"`, rule with name `host_priority1` will be hit.
 
 ### Path precision first when hostname are identical
 ```yaml
@@ -83,7 +83,7 @@ spec:
               serviceName: service2
               servicePort: 80
 ```
-In above example, for requests generated by `curl "http://example.net/bar/foo" -H "Key: value"`, rule in `path_priority1` will be hit
+In above example, for requests generated by `curl "http://example.net/bar/foo" -H "Key: value"`, rule with name `path_priority1` will be hit
 
 ### More matched advanced condition first, when hostname and path both identical
 ```yaml
@@ -123,7 +123,7 @@ spec:
               serviceName: service2
               servicePort: 80
 ```
-In above example, for requests generated by `curl "http://example.net/bar/foo" -H "Key: value"`, rule in `cond_priority1` will be hit
+In above example, for requests generated by `curl "http://example.net/bar/foo" -H "Key: value"`, rule with name `cond_priority1` will be hit
 
 ### Matched advanced condition with higher priority first, when above criteria are the same
 ```yaml
@@ -163,5 +163,5 @@ spec:
               serviceName: service2
               servicePort: 80
 ```
-In above example, for requests generated by `curl "http://example.net/bar/foo" -H "Header-key: value" --cookie "cookie-key: value"`, rule in `multi_cond_priority2` will be hit, as `Cookie` condition has higher priority than `Header` condition
+In above example, for requests generated by `curl "http://example.net/bar/foo" -H "Header-key: value" --cookie "cookie-key: value"`, rule with name `multi_cond_priority2` will be hit, for `Cookie` condition has higher priority than `Header` condition.
 

From 04f15e056800ab555271e89fc80c1825875a0090 Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 17:53:23 +0800
Subject: [PATCH 13/19] Update tls.md

---
 docs/en_us/ingress/tls.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/en_us/ingress/tls.md b/docs/en_us/ingress/tls.md
index b93f111d..6d16aa01 100644
--- a/docs/en_us/ingress/tls.md
+++ b/docs/en_us/ingress/tls.md
@@ -1,5 +1,5 @@
 # TLS Configuration
-BFE Ingress Controller manage TLS certificates and secretes in the way defined by Kubernetes.
+BFE Ingress Controller manages TLS certificates and secretes in the way defined by Kubernetes.
 
 TLS certificates and secretes are stored in `Secret`. See examples below:
 

From feb37e9a08dd24d44e8254fbf07b0e7ea0aa97e9 Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 17:54:36 +0800
Subject: [PATCH 14/19] Update load-balance.md

---
 docs/en_us/ingress/load-balance.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/en_us/ingress/load-balance.md b/docs/en_us/ingress/load-balance.md
index bc2f7505..d478b07c 100644
--- a/docs/en_us/ingress/load-balance.md
+++ b/docs/en_us/ingress/load-balance.md
@@ -1,7 +1,7 @@
 # Load banlancing between Services
 ## Introduction
 
-For `Service`s that providing the same service (called Sub-Services),  BFE Ingress Controller support load balancing between them, based on weight configured for each `Service`.
+For `Service`s that providing the same service (called Sub-Services),  BFE Ingress Controller supports load balancing between them, based on weight configured for each `Service`.
 
 ## Configuration
 
@@ -9,7 +9,7 @@ BFE Ingress Controller use `Annotation` to support load-balancing between multip
 
 - in `annotations`
 
-  - config weight for each Sub-Service.
+  - configurate weight for each Sub-Service.
 
   - define a `Service` name for the service they provided together：
 
@@ -45,4 +45,4 @@ spec:
         backend:
           serviceName: service
           servicePort: 80
-```
\ No newline at end of file
+```

From 8e894f9ee5262e4579cb80fcfdf7c493b1fa07ba Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 19:08:20 +0800
Subject: [PATCH 15/19] Update load-balance.md

---
 docs/en_us/ingress/load-balance.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/en_us/ingress/load-balance.md b/docs/en_us/ingress/load-balance.md
index d478b07c..40a71871 100644
--- a/docs/en_us/ingress/load-balance.md
+++ b/docs/en_us/ingress/load-balance.md
@@ -19,7 +19,7 @@ BFE Ingress Controller use `Annotation` to support load-balancing between multip
 
 - in `rules`
 
-  - config the `serviceName` of `backend` as the `Service` name in `Annotation`, and config the `servicePort`.
+  - set the `serviceName` of `backend` as the `Service` name in `Annotation`, and set the `servicePort`.
 
 ## Example
 

From d3e18979bff913fb66823e719a32a4daad9c3b26 Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 19:14:51 +0800
Subject: [PATCH 16/19] Update example.md

---
 docs/en_us/example/example.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/en_us/example/example.md b/docs/en_us/example/example.md
index f0f2ef5a..fa2d6345 100644
--- a/docs/en_us/example/example.md
+++ b/docs/en_us/example/example.md
@@ -1,9 +1,9 @@
-# Config File Example
+# Examples of Config File 
 
 ## deployment
 | Program | File | Description |
 | ---- | ---- | ---- |
-| bfe-ingress-controller  | [controller.yaml](../../../examples/controller.yaml)| to deploy Bfe Ingress Controller |
+| bfe-ingress-controller  | [controller.yaml](../../../examples/controller.yaml)| to deploy BFE Ingress Controller |
 | example backend service: whoami | [whoami.yaml](../../../examples/whoami.yaml) | to deploy example service `whoami` |
 
 ## ingress
@@ -14,5 +14,5 @@
 ## rbac
 | File | Description |
 | ---- | ---- |
-| [rbac.yaml](../../../examples/rbac.yaml) | to config access control for Bfe Ingress Controller |
+| [rbac.yaml](../../../examples/rbac.yaml) | to config access control for BFE Ingress Controller |
 

From f0feff52b7b0f69dc173c8554720afb8a93bd834 Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 19:34:04 +0800
Subject: [PATCH 17/19] Update canary-release.md

---
 docs/en_us/example/canary-release.md | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/docs/en_us/example/canary-release.md b/docs/en_us/example/canary-release.md
index efaba18e..d1f22728 100644
--- a/docs/en_us/example/canary-release.md
+++ b/docs/en_us/example/canary-release.md
@@ -1,10 +1,10 @@
 # Canary Release
 
 ## Introduction
-BFE Ingress Controller support `Header/Cookie` based "canary release" by configuring`Annotation`.
+BFE Ingress Controller supports `Header/Cookie` based "canary release" by configuring`Annotation`.
 
 ## Config Example
-* Original ingress config as follows, which will forward matched requests to `service`：
+* Original ingress configuration is shown as follows. Ingress will forward matched requests to `service`：
 ```yaml
 kind: Ingress
 apiVersion: networking.k8s.io/v1beta1
@@ -24,8 +24,8 @@ spec:
               servicePort: 80
 ```
 
-* Canary release is required and interested requests should be forwarded to a new service `service2`.
-* To implement this, create a new ingress, with header or cookie information of  interested requests included in annotations.
+* Canary release is applied and interested requests should be forwarded to a new service `service2`.
+* To achieve this, create a new ingress, with header or cookie information of interested requests included in annotations.
 ```yaml
 kind: Ingress
 apiVersion: networking.k8s.io/v1beta1
@@ -48,8 +48,8 @@ spec:
               servicePort: 80
 
 ```
-* Based on above config, BFE Ingress Controller will
-1. requests with `host == example.net && path == /bar && cookie[key] == value && Header[Key] == Value`,
-   forwarded to service `service-new`
-1. other request with `host == example.net && path == /bar`，
-   forwarded to service `service`
+* Based on above configuration, BFE Ingress Controller will
+1. forward requests with `host == example.net && path == /bar && cookie[key] == value && Header[Key] == Value`
+   to service `service-new`
+1. forward other requests with `host == example.net && path == /bar`
+   to service `service`

From d8dc87b7c81b7c35493468213559d0e46bfa1bad Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 19:47:45 +0800
Subject: [PATCH 18/19] Update tls.md

---
 docs/en_us/ingress/tls.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/en_us/ingress/tls.md b/docs/en_us/ingress/tls.md
index 6d16aa01..c820cbd8 100644
--- a/docs/en_us/ingress/tls.md
+++ b/docs/en_us/ingress/tls.md
@@ -3,7 +3,7 @@ BFE Ingress Controller manages TLS certificates and secretes in the way defined
 
 TLS certificates and secretes are stored in `Secret`. See examples below:
 
-**Config Secret**
+**Configurate Secret**
 
 ```yaml
 apiVersion: v1
@@ -16,7 +16,7 @@ data:
   tls.key: base64 encoded key
 type: kubernetes.io/tls
 ```
-**Config Ingress**
+**Configurate Ingress**
 
 ```yaml
 apiVersion: networking.k8s.io/v1beta1

From 7b15d653a0b87837a38cdd0869e8a98dca6d025e Mon Sep 17 00:00:00 2001
From: Miles Zhang <zhangmiao02@baidu.com>
Date: Mon, 25 Oct 2021 19:54:06 +0800
Subject: [PATCH 19/19] Update FAQ.md

---
 docs/en_us/FAQ/FAQ.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/en_us/FAQ/FAQ.md b/docs/en_us/FAQ/FAQ.md
index b03480c2..e64a9140 100644
--- a/docs/en_us/FAQ/FAQ.md
+++ b/docs/en_us/FAQ/FAQ.md
@@ -5,8 +5,8 @@
 
 |Argument | Default value | Description|
 | --- | --- | --- |
-| --namespace <br> -n | Null | Specifies in which namespaces the BFE Ingress Controller will monitor Ingress, seperate multiple namespaces by `,`. <br>Default value means monitor all namespaces  |
-| --ingress-class| bfe | Specifies the `kubernetes.io/ingress.class` value of Ingress it monitors. <br>If not specified, BFE Ingress Controller monitors the Ingress with ingress class set as bfe. Usually you don't need to specify it. |
+| --namespace <br> -n | Null | Specify in which namespaces BFE Ingress Controller will monitor Ingress. Multiple namespaces are seperated by `,`. <br>Default value means to monitor all namespaces.  |
+| --ingress-class| bfe | Specify the `kubernetes.io/ingress.class` value of Ingress it monitors. <br>If not specified, BFE Ingress Controller monitors the Ingress with ingress class set as "bfe". Usually you don't need to specify it. |
 | --default-backend| Null | Specify name of default backend service, in the format of `namespace/name`.<br>If specified, requests that match no Ingress rule will be forwarded to the service specified. |
 
 How to define：