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 2020/07/21 17:53:50 UTC
[GitHub] [incubator-apisix] Miss-you opened a new pull request #1884: [doc] Use pangu plug-in to format Chinese documents
Miss-you opened a new pull request #1884:
URL: https://github.com/apache/incubator-apisix/pull/1884
### 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. -->
Use pangu plug-in to format Chinese documents
### Pre-submission checklist:
* [ ] 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?
* [ ] Is this PR backward compatible?
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-apisix] juzhiyuan commented on a change in pull request #1884: [doc] Use pangu plug-in to format Chinese documents
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #1884:
URL: https://github.com/apache/incubator-apisix/pull/1884#discussion_r459381361
##########
File path: FAQ_CN.md
##########
@@ -197,15 +195,15 @@ Server: APISIX web server
## 如何修改日志等级
-默认的APISIX日志等级为`warn`，如果需要查看`core.log.info`的打印结果需要将日志等级调整为`info`。
+默认的 APISIX 日志等级为`warn`，如果需要查看`core.log.info`的打印结果需要将日志等级调整为`info`。
具体步骤：
-1、修改conf/config.yaml中的nginx log配置参数`error_log_level: "warn"`为`error_log_level: "info"`。
+1、修改 conf/config.yaml 中的 nginx log 配置参数`error_log_level: "warn"`为`error_log_level: "info"`。
Review comment:
use `conf/config.yaml` please
##########
File path: FAQ_CN.md
##########
@@ -220,3 +218,25 @@ curl http://127.0.0.1:9080/apisix/admin/plugins/reload -H 'X-API-KEY: edd1c9f034
```shell
apisix reload
```
+
+## 如何格式化中文文档？
+
+中文文档对于格式有很多要求，比如英文单词前后要有空格` `，但每次手动修改都非常繁琐，有没有省时省力的办法解决这个问题？
Review comment:
We'd better use a more direct way to tell users what happened and how to deal with it.
e.g: 中文文档对于格式有很多要求：如英文单词前后应有空格` `，由于手动修改十分繁琐，我们在 VS Code 中使用 [`Pangu-Markdown`](https://marketplace.visualstudio.com/items?itemName=xlthu.Pangu-Markdown)插件解决该问题。
##########
File path: FAQ_CN.md
##########
@@ -197,15 +195,15 @@ Server: APISIX web server
## 如何修改日志等级
-默认的APISIX日志等级为`warn`，如果需要查看`core.log.info`的打印结果需要将日志等级调整为`info`。
+默认的 APISIX 日志等级为`warn`，如果需要查看`core.log.info`的打印结果需要将日志等级调整为`info`。
Review comment:
Do we need a space before `warn`?
##########
File path: FAQ_CN.md
##########
@@ -220,3 +218,25 @@ curl http://127.0.0.1:9080/apisix/admin/plugins/reload -H 'X-API-KEY: edd1c9f034
```shell
apisix reload
```
+
+## 如何格式化中文文档？
+
+中文文档对于格式有很多要求，比如英文单词前后要有空格` `，但每次手动修改都非常繁琐，有没有省时省力的办法解决这个问题？
+
+推荐使用 vscode 的 pangu 插件
+
+**安装方式**
+
+进入 vscode 插件列表，搜索`pangu`，安装`Pangu-Markdown`插件
+
+
+
+**使用方式**
+
+进入 vscode 命令行模式，选择 `Pangu Format`
Review comment:
use `Command + P` to show the commands panel on Mac?
##########
File path: FAQ_CN.md
##########
@@ -220,3 +218,25 @@ curl http://127.0.0.1:9080/apisix/admin/plugins/reload -H 'X-API-KEY: edd1c9f034
```shell
apisix reload
```
+
+## 如何格式化中文文档？
+
+中文文档对于格式有很多要求，比如英文单词前后要有空格` `，但每次手动修改都非常繁琐，有没有省时省力的办法解决这个问题？
+
+推荐使用 vscode 的 pangu 插件
+
+**安装方式**
+
+进入 vscode 插件列表，搜索`pangu`，安装`Pangu-Markdown`插件
+
+
+
+**使用方式**
+
+进入 vscode 命令行模式，选择 `Pangu Format`
+
+
+
+**注意**
+
+不建议选用 pangu 这个名字的插件，它对 `**` 这种加粗字符支持不友好
Review comment:
We could recommend users to use the correct `Pangu-Markdown` plugin directly.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-apisix] Miss-you commented on a change in pull request #1884: [doc] Use pangu plug-in to format Chinese documents
Posted by GitBox <gi...@apache.org>.
Miss-you commented on a change in pull request #1884:
URL: https://github.com/apache/incubator-apisix/pull/1884#discussion_r459909061
##########
File path: FAQ_CN.md
##########
@@ -220,3 +218,25 @@ curl http://127.0.0.1:9080/apisix/admin/plugins/reload -H 'X-API-KEY: edd1c9f034
```shell
apisix reload
```
+
+## 如何格式化中文文档？
+
+中文文档对于格式有很多要求，比如英文单词前后要有空格` `，但每次手动修改都非常繁琐，有没有省时省力的办法解决这个问题？
+
+推荐使用 vscode 的 pangu 插件
+
+**安装方式**
+
+进入 vscode 插件列表，搜索`pangu`，安装`Pangu-Markdown`插件
+
+
+
+**使用方式**
+
+进入 vscode 命令行模式，选择 `Pangu Format`
Review comment:
shift + command + p
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org