You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/03/15 09:18:55 UTC

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

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-unsubscribe@apisix.apache.org

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