[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-22 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r832872804



##
File path: .github/workflows/doc-lint.yml
##
@@ -34,3 +34,15 @@ jobs:
 echo "You need to run ./utils/fix-zh-doc-segment.py to fix them."
 exit 1
   fi
+
+  Chinse-Copywriting-lint:
+name: Chinese Copywriting
+runs-on: ubuntu-latest
+timeout-minutes: 1
+steps:
+  - uses: actions/checkout@v3
+  - name: check Chinese copywriting
+run: |
+  curl -sSL https://git.io/JcGER | bash
+  autocorrect --version

Review comment:
   Hi @kwanhur, significant changes! 🎉
   
   I just reviewed what apisix-dashboard does, the submodule uses a specific 
commit id, but `get_latest_release` will always get the latest releases. If 
this repo releases a new version with unexpected codes, it will not look good 
for us either.
   
   Hope you can understand and use a specific version/commit instead of the 
latest. ❤️
   
   
![image](https://user-images.githubusercontent.com/2106987/159632416-6575272f-bcae-456e-bd39-46f1d28f787b.png)
   




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-22 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r832765769



##
File path: .github/workflows/doc-lint.yml
##
@@ -34,3 +34,15 @@ jobs:
 echo "You need to run ./utils/fix-zh-doc-segment.py to fix them."
 exit 1
   fi
+
+  Chinse-Copywriting-lint:
+name: Chinese Copywriting
+runs-on: ubuntu-latest
+timeout-minutes: 1
+steps:
+  - uses: actions/checkout@v3
+  - name: check Chinese copywriting
+run: |
+  curl -sSL https://git.io/JcGER | bash
+  autocorrect --version

Review comment:
   That's good!




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-22 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r832113398



##
File path: .github/workflows/doc-lint.yml
##
@@ -34,3 +34,15 @@ jobs:
 echo "You need to run ./utils/fix-zh-doc-segment.py to fix them."
 exit 1
   fi
+
+  Chinse-Copywriting-lint:
+name: Chinese Copywriting
+runs-on: ubuntu-latest
+timeout-minutes: 1
+steps:
+  - uses: actions/checkout@v3
+  - name: check Chinese copywriting
+run: |
+  curl -sSL https://git.io/JcGER | bash
+  autocorrect --version

Review comment:
   I'm only concerned about whether the link `https://git.io/JcGER` will 
contain not good codes? 😄 Because it's not versioned (that's why the ASF asks 
to use a specified submodule instead).
   
   cc @bzp2010 @Yiyiyimu to have a confirmation. If it's good to go, then let't 
merge this PR with honor! 😄




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-21 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r830832776



##
File path: .github/workflows/doc-lint.yml
##
@@ -34,3 +34,15 @@ jobs:
 echo "You need to run ./utils/fix-zh-doc-segment.py to fix them."
 exit 1
   fi
+
+  Chinse-Copywriting-lint:
+name: Chinese Copywriting
+runs-on: ubuntu-latest
+timeout-minutes: 1
+steps:
+  - uses: actions/checkout@v3
+  - name: check Chinese copywriting
+run: |
+  curl -sSL https://git.io/JcGER | bash
+  autocorrect --version

Review comment:
   cc @spacewander @moonming  to have a confirmation.




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-21 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r830830909



##
File path: .github/workflows/doc-lint.yml
##
@@ -34,3 +34,15 @@ jobs:
 echo "You need to run ./utils/fix-zh-doc-segment.py to fix them."
 exit 1
   fi
+
+  Chinse-Copywriting-lint:
+name: Chinese Copywriting
+runs-on: ubuntu-latest
+timeout-minutes: 1
+steps:
+  - uses: actions/checkout@v3
+  - name: check Chinese copywriting
+run: |
+  curl -sSL https://git.io/JcGER | bash
+  autocorrect --version

Review comment:
   According to ASF's policies, we have to use a submodule instead of cURL 
a link, bcoz we can't control the link and its service :(




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-20 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r830710508



##
File path: docs/zh/latest/plugins/traffic-split.md
##
@@ -40,7 +40,7 @@ traffic-split 插件使用户可以逐步引导各个上游之间的流量百分
 | upstream.hash_on   | enum   | 可选   | vars | | `hash_on` 支持的类型有 
`vars`(Nginx 内置变量),`header`(自定义 
header),`cookie`,`consumer`,`vars_combinations`,默认值为 `vars`。更多详细信息请参考 
[upstream](../admin-api.md#upstream) 用法。|
 | upstream.key   | string | 可选   |  ||  该选项只有类型是 
`chash` 才有效。根据 `key` 来查找对应的 node `id`,相同的 `key` 在同一个对象中,永远返回相同 id。更多详细信息请参考 
[upstream](../admin-api.md#upstream) 用法。 |
 | upstream.nodes | object | 可选   ||| 哈希表,内部元素的 
key 是上游机器地址 列表,格式为地址 + Port,其中地址部 分可以是 IP 也可以是域名,⽐如 192.168.1.100:80、foo.com:80 
等。 value 则是节点的权重,特别的,当权重 值为 0 有特殊含义,通常代表该上游节点 失效,永远不希望被选中。 |
-| upstream.timeout   | object | 可选   |  15 || 
设置连接、发送消息、接收消息的超时时间(时间单位:秒,都默认为 15 秒)。 |
+| upstream.timeout   | object | 可选   |  15 || 
设置连接、发送消息、接收消息的超时时间 (时间单位:秒,都默认为 15 秒)。 |
 | upstream.pass_host | enum   | 可选   | "pass"   | ["pass", "node", 
"rewrite"]  | `pass`: 将客户端的 host 透传给上游; `node`: 使用 `upstream`  node 中配置的 host; 
`rewrite`: 使用配置项 `upstream_host` 的值 |

Review comment:
   Hi @yzeng25, could you please have a review and resolve some conversions?




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-19 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r830490022



##
File path: docs/zh/latest/plugins/gzip.md
##
@@ -25,7 +25,7 @@ title: gzip
 
 `gzip` 插件能动态设置 `Nginx` 的压缩行为。
 
-**该插件要求 `APISIX` 运行在 
[APISIX-OpenResty](../how-to-build.md#步骤6:为-apache-apisix-构建-openresty) 上。**
+**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤 
6:为-apache-apisix-构建-openresty) 上。**

Review comment:
   It seems a little "tricky" but works, LGTM 😅 




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-18 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r829025065



##
File path: docs/zh/latest/plugins/gzip.md
##
@@ -25,7 +25,7 @@ title: gzip
 
 `gzip` 插件能动态设置 `Nginx` 的压缩行为。
 
-**该插件要求 `APISIX` 运行在 
[APISIX-OpenResty](../how-to-build.md#步骤6:为-apache-apisix-构建-openresty) 上。**
+**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤 
6:为-apache-apisix-构建-openresty) 上。**

Review comment:
   I don't have other better ways, we have to make a trade off here :>

##
File path: docs/zh/latest/plugins/gzip.md
##
@@ -25,7 +25,7 @@ title: gzip
 
 `gzip` 插件能动态设置 `Nginx` 的压缩行为。
 
-**该插件要求 `APISIX` 运行在 
[APISIX-OpenResty](../how-to-build.md#步骤6:为-apache-apisix-构建-openresty) 上。**
+**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤 
6:为-apache-apisix-构建-openresty) 上。**

Review comment:
   I don't have other better ways, we have to make a tradeoff here :>




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-17 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r829025065



##
File path: docs/zh/latest/plugins/gzip.md
##
@@ -25,7 +25,7 @@ title: gzip
 
 `gzip` 插件能动态设置 `Nginx` 的压缩行为。
 
-**该插件要求 `APISIX` 运行在 
[APISIX-OpenResty](../how-to-build.md#步骤6:为-apache-apisix-构建-openresty) 上。**
+**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤 
6:为-apache-apisix-构建-openresty) 上。**

Review comment:
   I don't have other better ways, we have to make a trade off here :>

##
File path: docs/zh/latest/plugins/gzip.md
##
@@ -25,7 +25,7 @@ title: gzip
 
 `gzip` 插件能动态设置 `Nginx` 的压缩行为。
 
-**该插件要求 `APISIX` 运行在 
[APISIX-OpenResty](../how-to-build.md#步骤6:为-apache-apisix-构建-openresty) 上。**
+**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤 
6:为-apache-apisix-构建-openresty) 上。**

Review comment:
   I don't have other better ways, we have to make a tradeoff here :>




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-16 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r828711025



##
File path: docs/zh/latest/plugins/gzip.md
##
@@ -25,7 +25,7 @@ title: gzip
 
 `gzip` 插件能动态设置 `Nginx` 的压缩行为。
 
-**该插件要求 `APISIX` 运行在 
[APISIX-OpenResty](../how-to-build.md#步骤6:为-apache-apisix-构建-openresty) 上。**
+**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤 
6:为-apache-apisix-构建-openresty) 上。**

Review comment:
   Why not use English and Number as Heading IDs?




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-15 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r827656616



##
File path: .github/workflows/doc-lint.yml
##
@@ -34,3 +34,15 @@ jobs:
 echo "You need to run ./utils/fix-zh-doc-segment.py to fix them."
 exit 1
   fi
+
+  Chinse-Copywriting-lint:
+name: Chinese Copywriting
+runs-on: ubuntu-latest
+timeout-minutes: 1
+steps:
+  - uses: actions/checkout@v3
+  - name: check Chinese copywriting
+run: |
+  curl -sSL https://git.io/JcGER | bash
+  autocorrect --version

Review comment:
   see 
https://github.com/apache/apisix-dashboard/tree/master/.github/actions
   
   We're using submodule in dashboard project 😅




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-15 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r827628842



##
File path: docs/zh/latest/plugins/gzip.md
##
@@ -25,7 +25,7 @@ title: gzip
 
 `gzip` 插件能动态设置 `Nginx` 的压缩行为。
 
-**该插件要求 `APISIX` 运行在 
[APISIX-OpenResty](../how-to-build.md#步骤6:为-apache-apisix-构建-openresty) 上。**
+**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤 
6:为-apache-apisix-构建-openresty) 上。**

Review comment:
   
[docs/zh/latest/plugins/gzip.md](https://github.com/apache/apisix/pull/6568/files/feaf3d0c20e9612a63882b6a414b6a50148dbbc3#diff-642ed4e3cc78101ac869166d3568f8910fdca52ab5483c241c775e6411eaf985)
   
   But this file is `gzip.md` 😂 not `how-to-build.md`




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-15 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r827628063



##
File path: .github/workflows/doc-lint.yml
##
@@ -34,3 +34,15 @@ jobs:
 echo "You need to run ./utils/fix-zh-doc-segment.py to fix them."
 exit 1
   fi
+
+  Chinse-Copywriting-lint:
+name: Chinese Copywriting
+runs-on: ubuntu-latest
+timeout-minutes: 1
+steps:
+  - uses: actions/checkout@v3
+  - name: check Chinese copywriting
+run: |
+  curl -sSL https://git.io/JcGER | bash
+  autocorrect --version

Review comment:
   Check this 
https://github.com/apache/apisix/issues/6528#issuecomment-1062579469




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-15 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r827627556



##
File path: docs/zh/latest/plugins/gzip.md
##
@@ -25,7 +25,7 @@ title: gzip
 
 `gzip` 插件能动态设置 `Nginx` 的压缩行为。
 
-**该插件要求 `APISIX` 运行在 
[APISIX-OpenResty](../how-to-build.md#步骤6:为-apache-apisix-构建-openresty) 上。**
+**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤 
6:为-apache-apisix-构建-openresty) 上。**

Review comment:
   Please check this file: 
https://github.com/kwanhur/apisix/blob/typo-zh-copywriting/docs/zh/latest/plugins/gzip.md
   
   😅




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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




[GitHub] [apisix] juzhiyuan commented on a change in pull request #6568: docs(lint): import Chinese copywriting autocorrect linter

2022-03-15 Thread GitBox


juzhiyuan commented on a change in pull request #6568:
URL: https://github.com/apache/apisix/pull/6568#discussion_r826741259



##
File path: docs/zh/latest/plugins/proxy-control.md
##
@@ -25,7 +25,7 @@ title: proxy-control
 
 `proxy-control` 能够动态地控制 Nginx 代理的行为。
 
-**这个插件需要APISIX在 
[APISIX-OpenResty](../how-to-build.md#步骤6:为-apache-apisix-构建-openresty)上运行。**
+**这个插件需要 APISIX 在 [APISIX-OpenResty](../how-to-build.md#步骤 
6:为-apache-apisix-构建-openresty) 上运行。**

Review comment:
   ditto

##
File path: docs/zh/latest/plugins/gzip.md
##
@@ -25,7 +25,7 @@ title: gzip
 
 `gzip` 插件能动态设置 `Nginx` 的压缩行为。
 
-**该插件要求 `APISIX` 运行在 
[APISIX-OpenResty](../how-to-build.md#步骤6:为-apache-apisix-构建-openresty) 上。**
+**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤 
6:为-apache-apisix-构建-openresty) 上。**

Review comment:
   🤔 We'd better use English and Number as Markdown's Heading IDs

##
File path: .github/workflows/doc-lint.yml
##
@@ -34,3 +34,15 @@ jobs:
 echo "You need to run ./utils/fix-zh-doc-segment.py to fix them."
 exit 1
   fi
+
+  Chinse-Copywriting-lint:
+name: Chinese Copywriting
+runs-on: ubuntu-latest
+timeout-minutes: 1
+steps:
+  - uses: actions/checkout@v3
+  - name: check Chinese copywriting
+run: |
+  curl -sSL https://git.io/JcGER | bash
+  autocorrect --version

Review comment:
   Hi, will this change PR's contents?

##
File path: docs/zh/latest/plugins/real-ip.md
##
@@ -27,7 +27,7 @@ title: real-ip
 
 它工作方式和 `Nginx` 里 `ngx_http_realip_module` 模块一样,并且更为灵活。
 
-**该插件要求 `APISIX` 运行在 
[APISIX-OpenResty](../how-to-build.md#步骤6:为-apache-apisix-构建-openresty) 上。**
+**该插件要求 `APISIX` 运行在 [APISIX-OpenResty](../how-to-build.md#步骤 
6:为-apache-apisix-构建-openresty) 上。**

Review comment:
   ditto

##
File path: .github/workflows/doc-lint.yml
##
@@ -34,3 +34,15 @@ jobs:
 echo "You need to run ./utils/fix-zh-doc-segment.py to fix them."
 exit 1
   fi
+
+  Chinse-Copywriting-lint:
+name: Chinese Copywriting
+runs-on: ubuntu-latest
+timeout-minutes: 1
+steps:
+  - uses: actions/checkout@v3
+  - name: check Chinese copywriting
+run: |
+  curl -sSL https://git.io/JcGER | bash
+  autocorrect --version

Review comment:
   Also, could we use a submodule to execute this CI for security 
considerations?




-- 
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.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

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