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 2021/11/01 19:12:01 UTC

[GitHub] [apisix] leslie-tsang opened a new pull request #5392: docs: fix broken link in zh docs

leslie-tsang opened a new pull request #5392:
URL: https://github.com/apache/apisix/pull/5392


   Signed-off-by: leslie <le...@icloud.com>
   
   ### What this PR does / why we need it:
   <!--- Why is this change required? What problem does it solve? -->
   <!--- If it fixes an open issue, please link to the issue here. -->
   fix broken link in zh docs
   
   ### Pre-submission checklist:
   
   <!--
   Please follow the requirements:
   1. Use Draft if the PR is not ready to be reviewed
   2. Test is required for the feat/fix PR, unless you have a good reason
   3. Doc is required for the feat PR
   4. Use a new commit to resolve review instead of `push -f`
   5. Use "request review" to notify the reviewer once you have resolved the review
   -->
   
   * [x] Did you explain what problem does this PR solve? Or what new features have been added?
   * [ ] Have you added corresponding test cases?
   * [ ] Have you modified the corresponding document?
   * [x] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix/tree/master#community) first**
   


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



[GitHub] [apisix] juzhiyuan commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r740664942



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @leslie-tsang Hi, due to some different logics between github.com and https://docusaurus.io/ , we need to use a custom ID for those headers.
   
   **Description**
   
   We have one markdown file, see `https://github.com/apache/apisix/blob/master/docs/zh/latest/how-to-build.md#%E6%AD%A5%E9%AA%A46%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   The URL is as follows:
   
   ![image](https://user-images.githubusercontent.com/2106987/139772763-0a56c173-0a31-4b83-8d1b-cf36d45789ca.png)
   
   After it's transformed to Apache APISIX Website, the URL is as follows:
   
   `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#%E6%AD%A5%E9%AA%A46%EF%BC%9A%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   ![image](https://user-images.githubusercontent.com/2106987/139772816-80a58ddc-4074-46c0-a033-c49f43fef35c.png)
   
   **Issue**
   
   We noticed that the URL is missing a `:`(in Chinese) in GitHub (see the first image).
   
   **Guess**
   
   1. The correct one is just like the second image on the website, `#xxxx` is a Slash.
   2. GitHub maybe lose the needed `:`, it will break the Slash effect.
   
   **Expect**
   
   When we open links, it will navigate to the target section.
   
   **Solution**
   
   We could use custom header ids to fix this issue, see https://uhded.com/add-id-header-markdown .
   
   Advantage: The sharable URL will be shorter and more semantic than the Chinese encoded style.
   
   **What we do next**
   
   We need to set custom ids (English or number) for those markdown headers :)
   
   @leslie-tsang Would you like to do this?




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



[GitHub] [apisix] leslie-tsang commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
leslie-tsang commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r740668867



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @juzhiyuan Sure.




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



[GitHub] [apisix] github-actions[bot] commented on pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#issuecomment-1007284606


   This pull request has been marked as stale due to 60 days of inactivity. It will be closed in 4 weeks if no further activity occurs. If you think that's incorrect or this pull request should instead be reviewed, please simply write any comment. Even if closed, you can still revive the PR at any time or discuss it on the dev@apisix.apache.org list. Thank you for your contributions.


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



[GitHub] [apisix] spacewander commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r740654033



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       Look like the doc site uses different way to generate the anchor, see https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#步骤6:为-apache-apisix-构建-openresty
   
   CC @juzhiyuan 




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



[GitHub] [apisix] juzhiyuan commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r740664942



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @leslie-tsang Hi, due to some different logics between https://github.com and https://docusaurus.io/ , we need to use a custom ID for those headers.
   
   **Description**
   
   We have one markdown file, see `https://github.com/apache/apisix/blob/master/docs/zh/latest/how-to-build.md#%E6%AD%A5%E9%AA%A46%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   The URL is as follows:
   
   ![image](https://user-images.githubusercontent.com/2106987/139772763-0a56c173-0a31-4b83-8d1b-cf36d45789ca.png)
   
   After it's transformed to Apache APISIX Website, the URL is as follows:
   
   `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#%E6%AD%A5%E9%AA%A46%EF%BC%9A%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   ![image](https://user-images.githubusercontent.com/2106987/139772816-80a58ddc-4074-46c0-a033-c49f43fef35c.png)
   
   **Issue**
   
   We noticed that the URL is missing a `:`(in Chinese) in GitHub (see the first image).
   
   **Guess**
   
   1. The correct one is just like the second image on the website, `#xxxx` is a Slash.
   2. GitHub maybe lose the needed `:`, it will break the Slash effect.
   
   **Expect**
   
   When we open links, it will navigate to the target section.
   
   **Solution**
   
   We could use custom header ids to fix this issue, see https://uhded.com/add-id-header-markdown .
   
   Advantage: The sharable URL will be shorter and more semantic than the Chinese encoded style.
   
   **What we do next**
   
   We need to set custom ids (English or number) for those markdown headers :)
   
   @leslie-tsang Would you like to do this?




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



[GitHub] [apisix] juzhiyuan commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r740664942



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @leslie-tsang Hi, due to some different logics between https://github.com and https://docusaurus.io/ , we need to use a custom ID for those headers.
   
   **Description**
   
   We have one markdown file, see `https://github.com/apache/apisix/blob/master/docs/zh/latest/how-to-build.md#%E6%AD%A5%E9%AA%A46%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   The URL is as follows:
   
   ![image](https://user-images.githubusercontent.com/2106987/139772763-0a56c173-0a31-4b83-8d1b-cf36d45789ca.png)
   
   After it's transformed to Apache APISIX Website, the URL is as follows:
   
   `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#%E6%AD%A5%E9%AA%A46%EF%BC%9A%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   ![image](https://user-images.githubusercontent.com/2106987/139772816-80a58ddc-4074-46c0-a033-c49f43fef35c.png)
   
   **Issue**
   
   We noticed that the URL is missing a `:`(in Chinese) in GitHub (see the first image).
   
   **Guess**
   
   1. The correct one is just like the second image on the website, `#xxxx` is a Slash.
   2. GitHub maybe lose the needed `:`, it will break the Slash effect.
   
   **Expect**
   
   When we open links, it will navigate to the target section.
   
   **Solution**
   
   We could use custom header ids to fix this issue, see https://uhded.com/add-id-header-markdown .
   
   Advantage: The sharable URL will be shorter and more semantic than the Chinese encoded style. Example: `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#how-to-build-openresty`
   
   **What we do next**
   
   We need to set custom ids (English or number) for those markdown headers :)
   
   @leslie-tsang Would you like to do this?




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



[GitHub] [apisix] leslie-tsang commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
leslie-tsang commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r740668867



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @juzhiyuan Sure.




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



[GitHub] [apisix] juzhiyuan commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r740664942



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @leslie-tsang Hi, due to some different logics between https://github.com and https://docusaurus.io/ , we need to use a custom ID for those headers.
   
   **Description**
   
   We have one markdown file, see `https://github.com/apache/apisix/blob/master/docs/zh/latest/how-to-build.md#%E6%AD%A5%E9%AA%A46%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   The URL is as follows:
   
   ![image](https://user-images.githubusercontent.com/2106987/139772763-0a56c173-0a31-4b83-8d1b-cf36d45789ca.png)
   
   After it's transformed to Apache APISIX Website, the URL is as follows:
   
   `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#%E6%AD%A5%E9%AA%A46%EF%BC%9A%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   ![image](https://user-images.githubusercontent.com/2106987/139772816-80a58ddc-4074-46c0-a033-c49f43fef35c.png)
   
   **Issue**
   
   We noticed that the URL is missing a `:`(in Chinese) in GitHub (see the first image).
   
   **Guess**
   
   1. The correct one is just like the second image on the website, `#xxxx` is a Slash.
   2. GitHub maybe lose the needed `:`, it will break the Slash effect.
   
   **Expect**
   
   When we open links, it will navigate to the target section.
   
   **Solution**
   
   We could use custom header ids to fix this issue, see https://uhded.com/add-id-header-markdown .
   
   Advantage: The sharable URL will be shorter and more semantic than the Chinese encoded style. Example: `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#openresty`
   
   **What we do next**
   
   We need to set custom ids (English or number) for those markdown headers :)
   
   @leslie-tsang Would you like to do this?




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



[GitHub] [apisix] juzhiyuan commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r740664942



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @leslie-tsang Hi, due to some different logics between github.com and https://docusaurus.io/ , we need to use a custom ID for those headers.
   
   **Description**
   
   We have one markdown file, see `https://github.com/apache/apisix/blob/master/docs/zh/latest/how-to-build.md#%E6%AD%A5%E9%AA%A46%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   The URL is as follows:
   
   ![image](https://user-images.githubusercontent.com/2106987/139772763-0a56c173-0a31-4b83-8d1b-cf36d45789ca.png)
   
   After it's transformed to Apache APISIX Website, the URL is as follows:
   
   `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#%E6%AD%A5%E9%AA%A46%EF%BC%9A%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   ![image](https://user-images.githubusercontent.com/2106987/139772816-80a58ddc-4074-46c0-a033-c49f43fef35c.png)
   
   **Issue**
   
   We noticed that the URL is missing a `:`(in Chinese) in GitHub (see the first image).
   
   **Guess**
   
   1. The correct one is just like the second image on the website, `#xxxx` is a Slash.
   2. GitHub maybe lose the needed `:`, it will break the Slash effect.
   
   **Expect**
   
   When we open links, it will navigate to the target section.
   
   **Solution**
   
   We could use custom header ids to fix this issue, see https://uhded.com/add-id-header-markdown .
   
   Advantage: The sharable URL will be shorter and more semantic than the Chinese encoded style.
   
   **What we do next**
   
   We need to set custom ids (English or number) for those markdown headers :)
   
   @leslie-tsang Would you like to do this?

##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @leslie-tsang Hi, due to some different logics between https://github.com and https://docusaurus.io/ , we need to use a custom ID for those headers.
   
   **Description**
   
   We have one markdown file, see `https://github.com/apache/apisix/blob/master/docs/zh/latest/how-to-build.md#%E6%AD%A5%E9%AA%A46%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   The URL is as follows:
   
   ![image](https://user-images.githubusercontent.com/2106987/139772763-0a56c173-0a31-4b83-8d1b-cf36d45789ca.png)
   
   After it's transformed to Apache APISIX Website, the URL is as follows:
   
   `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#%E6%AD%A5%E9%AA%A46%EF%BC%9A%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   ![image](https://user-images.githubusercontent.com/2106987/139772816-80a58ddc-4074-46c0-a033-c49f43fef35c.png)
   
   **Issue**
   
   We noticed that the URL is missing a `:`(in Chinese) in GitHub (see the first image).
   
   **Guess**
   
   1. The correct one is just like the second image on the website, `#xxxx` is a Slash.
   2. GitHub maybe lose the needed `:`, it will break the Slash effect.
   
   **Expect**
   
   When we open links, it will navigate to the target section.
   
   **Solution**
   
   We could use custom header ids to fix this issue, see https://uhded.com/add-id-header-markdown .
   
   Advantage: The sharable URL will be shorter and more semantic than the Chinese encoded style.
   
   **What we do next**
   
   We need to set custom ids (English or number) for those markdown headers :)
   
   @leslie-tsang Would you like to do this?

##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @leslie-tsang Hi, due to some different logics between https://github.com and https://docusaurus.io/ , we need to use a custom ID for those headers.
   
   **Description**
   
   We have one markdown file, see `https://github.com/apache/apisix/blob/master/docs/zh/latest/how-to-build.md#%E6%AD%A5%E9%AA%A46%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   The URL is as follows:
   
   ![image](https://user-images.githubusercontent.com/2106987/139772763-0a56c173-0a31-4b83-8d1b-cf36d45789ca.png)
   
   After it's transformed to Apache APISIX Website, the URL is as follows:
   
   `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#%E6%AD%A5%E9%AA%A46%EF%BC%9A%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   ![image](https://user-images.githubusercontent.com/2106987/139772816-80a58ddc-4074-46c0-a033-c49f43fef35c.png)
   
   **Issue**
   
   We noticed that the URL is missing a `:`(in Chinese) in GitHub (see the first image).
   
   **Guess**
   
   1. The correct one is just like the second image on the website, `#xxxx` is a Slash.
   2. GitHub maybe lose the needed `:`, it will break the Slash effect.
   
   **Expect**
   
   When we open links, it will navigate to the target section.
   
   **Solution**
   
   We could use custom header ids to fix this issue, see https://uhded.com/add-id-header-markdown .
   
   Advantage: The sharable URL will be shorter and more semantic than the Chinese encoded style. Example: `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#how-to-build-openresty`
   
   **What we do next**
   
   We need to set custom ids (English or number) for those markdown headers :)
   
   @leslie-tsang Would you like to do this?

##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @leslie-tsang Hi, due to some different logics between https://github.com and https://docusaurus.io/ , we need to use a custom ID for those headers.
   
   **Description**
   
   We have one markdown file, see `https://github.com/apache/apisix/blob/master/docs/zh/latest/how-to-build.md#%E6%AD%A5%E9%AA%A46%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   The URL is as follows:
   
   ![image](https://user-images.githubusercontent.com/2106987/139772763-0a56c173-0a31-4b83-8d1b-cf36d45789ca.png)
   
   After it's transformed to Apache APISIX Website, the URL is as follows:
   
   `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#%E6%AD%A5%E9%AA%A46%EF%BC%9A%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   ![image](https://user-images.githubusercontent.com/2106987/139772816-80a58ddc-4074-46c0-a033-c49f43fef35c.png)
   
   **Issue**
   
   We noticed that the URL is missing a `:`(in Chinese) in GitHub (see the first image).
   
   **Guess**
   
   1. The correct one is just like the second image on the website, `#xxxx` is a Slash.
   2. GitHub maybe lose the needed `:`, it will break the Slash effect.
   
   **Expect**
   
   When we open links, it will navigate to the target section.
   
   **Solution**
   
   We could use custom header ids to fix this issue, see https://uhded.com/add-id-header-markdown .
   
   Advantage: The sharable URL will be shorter and more semantic than the Chinese encoded style. Example: `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#openresty`
   
   **What we do next**
   
   We need to set custom ids (English or number) for those markdown headers :)
   
   @leslie-tsang Would you like to do this?

##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       ok, if you have unclear points, please @ me 😄 




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



[GitHub] [apisix] github-actions[bot] commented on pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#issuecomment-1007284606


   This pull request has been marked as stale due to 60 days of inactivity. It will be closed in 4 weeks if no further activity occurs. If you think that's incorrect or this pull request should instead be reviewed, please simply write any comment. Even if closed, you can still revive the PR at any time or discuss it on the dev@apisix.apache.org list. Thank you for your contributions.


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



[GitHub] [apisix] leslie-tsang commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
leslie-tsang commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r740668867



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @juzhiyuan Sure.




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



[GitHub] [apisix] juzhiyuan commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r740674055



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       ok, if you have unclear points, please @ me 😄 




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



[GitHub] [apisix] spacewander commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r740654033



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       Look like the doc site uses different way to generate the anchor, see https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#步骤6:为-apache-apisix-构建-openresty
   
   CC @juzhiyuan 




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



[GitHub] [apisix] juzhiyuan commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r740664942



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @leslie-tsang Hi, due to some different logics between github.com and https://docusaurus.io/ , we need to use a custom ID for those headers.
   
   **Description**
   
   We have one markdown file, see `https://github.com/apache/apisix/blob/master/docs/zh/latest/how-to-build.md#%E6%AD%A5%E9%AA%A46%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   The URL is as follows:
   
   ![image](https://user-images.githubusercontent.com/2106987/139772763-0a56c173-0a31-4b83-8d1b-cf36d45789ca.png)
   
   After it's transformed to Apache APISIX Website, the URL is as follows:
   
   `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#%E6%AD%A5%E9%AA%A46%EF%BC%9A%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   ![image](https://user-images.githubusercontent.com/2106987/139772816-80a58ddc-4074-46c0-a033-c49f43fef35c.png)
   
   **Issue**
   
   We noticed that the URL is missing a `:`(in Chinese) in GitHub (see the first image).
   
   **Guess**
   
   1. The correct one is just like the second image on the website, `#xxxx` is a Slash.
   2. GitHub maybe lose the needed `:`, it will break the Slash effect.
   
   **Expect**
   
   When we open links, it will navigate to the target section.
   
   **Solution**
   
   We could use custom header ids to fix this issue, see https://uhded.com/add-id-header-markdown .
   
   Advantage: The sharable URL will be shorter and more semantic than the Chinese encoded style.
   
   **What we do next**
   
   We need to set custom ids (English or number) for those markdown headers :)
   
   @leslie-tsang Would you like to do this?

##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @leslie-tsang Hi, due to some different logics between https://github.com and https://docusaurus.io/ , we need to use a custom ID for those headers.
   
   **Description**
   
   We have one markdown file, see `https://github.com/apache/apisix/blob/master/docs/zh/latest/how-to-build.md#%E6%AD%A5%E9%AA%A46%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   The URL is as follows:
   
   ![image](https://user-images.githubusercontent.com/2106987/139772763-0a56c173-0a31-4b83-8d1b-cf36d45789ca.png)
   
   After it's transformed to Apache APISIX Website, the URL is as follows:
   
   `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#%E6%AD%A5%E9%AA%A46%EF%BC%9A%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   ![image](https://user-images.githubusercontent.com/2106987/139772816-80a58ddc-4074-46c0-a033-c49f43fef35c.png)
   
   **Issue**
   
   We noticed that the URL is missing a `:`(in Chinese) in GitHub (see the first image).
   
   **Guess**
   
   1. The correct one is just like the second image on the website, `#xxxx` is a Slash.
   2. GitHub maybe lose the needed `:`, it will break the Slash effect.
   
   **Expect**
   
   When we open links, it will navigate to the target section.
   
   **Solution**
   
   We could use custom header ids to fix this issue, see https://uhded.com/add-id-header-markdown .
   
   Advantage: The sharable URL will be shorter and more semantic than the Chinese encoded style.
   
   **What we do next**
   
   We need to set custom ids (English or number) for those markdown headers :)
   
   @leslie-tsang Would you like to do this?

##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @leslie-tsang Hi, due to some different logics between https://github.com and https://docusaurus.io/ , we need to use a custom ID for those headers.
   
   **Description**
   
   We have one markdown file, see `https://github.com/apache/apisix/blob/master/docs/zh/latest/how-to-build.md#%E6%AD%A5%E9%AA%A46%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   The URL is as follows:
   
   ![image](https://user-images.githubusercontent.com/2106987/139772763-0a56c173-0a31-4b83-8d1b-cf36d45789ca.png)
   
   After it's transformed to Apache APISIX Website, the URL is as follows:
   
   `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#%E6%AD%A5%E9%AA%A46%EF%BC%9A%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   ![image](https://user-images.githubusercontent.com/2106987/139772816-80a58ddc-4074-46c0-a033-c49f43fef35c.png)
   
   **Issue**
   
   We noticed that the URL is missing a `:`(in Chinese) in GitHub (see the first image).
   
   **Guess**
   
   1. The correct one is just like the second image on the website, `#xxxx` is a Slash.
   2. GitHub maybe lose the needed `:`, it will break the Slash effect.
   
   **Expect**
   
   When we open links, it will navigate to the target section.
   
   **Solution**
   
   We could use custom header ids to fix this issue, see https://uhded.com/add-id-header-markdown .
   
   Advantage: The sharable URL will be shorter and more semantic than the Chinese encoded style. Example: `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#how-to-build-openresty`
   
   **What we do next**
   
   We need to set custom ids (English or number) for those markdown headers :)
   
   @leslie-tsang Would you like to do this?

##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @leslie-tsang Hi, due to some different logics between https://github.com and https://docusaurus.io/ , we need to use a custom ID for those headers.
   
   **Description**
   
   We have one markdown file, see `https://github.com/apache/apisix/blob/master/docs/zh/latest/how-to-build.md#%E6%AD%A5%E9%AA%A46%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   The URL is as follows:
   
   ![image](https://user-images.githubusercontent.com/2106987/139772763-0a56c173-0a31-4b83-8d1b-cf36d45789ca.png)
   
   After it's transformed to Apache APISIX Website, the URL is as follows:
   
   `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#%E6%AD%A5%E9%AA%A46%EF%BC%9A%E4%B8%BA-apache-apisix-%E6%9E%84%E5%BB%BA-openresty`
   
   ![image](https://user-images.githubusercontent.com/2106987/139772816-80a58ddc-4074-46c0-a033-c49f43fef35c.png)
   
   **Issue**
   
   We noticed that the URL is missing a `:`(in Chinese) in GitHub (see the first image).
   
   **Guess**
   
   1. The correct one is just like the second image on the website, `#xxxx` is a Slash.
   2. GitHub maybe lose the needed `:`, it will break the Slash effect.
   
   **Expect**
   
   When we open links, it will navigate to the target section.
   
   **Solution**
   
   We could use custom header ids to fix this issue, see https://uhded.com/add-id-header-markdown .
   
   Advantage: The sharable URL will be shorter and more semantic than the Chinese encoded style. Example: `https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#openresty`
   
   **What we do next**
   
   We need to set custom ids (English or number) for those markdown headers :)
   
   @leslie-tsang Would you like to do this?

##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       ok, if you have unclear points, please @ me 😄 




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



[GitHub] [apisix] spacewander commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r740654033



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       Look like the doc site uses different way to generate the anchor, see https://apisix.apache.org/zh/docs/apisix/next/how-to-build/#步骤6:为-apache-apisix-构建-openresty
   
   CC @juzhiyuan 




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



[GitHub] [apisix] juzhiyuan commented on a change in pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #5392:
URL: https://github.com/apache/apisix/pull/5392#discussion_r744343275



##########
File path: docs/zh/latest/admin-api.md
##########
@@ -588,11 +588,11 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
 
 `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。
 他们的格式和 SSL 对象的 `cert` 和 `key` 一样。
-这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6:为-Apache-APISIX-构建-OpenResty)。
+这个特性需要 APISIX 运行于 [APISIX-OpenResty](./how-to-build.md#步骤6为-apache-apisix-构建-openresty)。

Review comment:
       @leslie-tsang Hi, may I know the status of this PR? Do you need my help 😄 




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



[GitHub] [apisix] leslie-tsang closed pull request #5392: docs: fix broken link in zh docs

Posted by GitBox <gi...@apache.org>.
leslie-tsang closed pull request #5392:
URL: https://github.com/apache/apisix/pull/5392


   


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