Skip to content

docs: node-status.md#2615

Merged
juzhiyuan merged 5 commits intoapache:masterfrom
HelloBug0:patch-2
Nov 6, 2020
Merged

docs: node-status.md#2615
juzhiyuan merged 5 commits intoapache:masterfrom
HelloBug0:patch-2

Conversation

@HelloBug0
Copy link
Contributor

This is the description of plugin node-status in Chinese, and I'd love to submit the document in lEnglish later.
This PR is relate with issue#2379

@membphis
Copy link
Member

membphis commented Nov 3, 2020

CI failed, please take a look at the output: https://github.com/apache/apisix/pull/2615/checks?check_run_id=1347360640#step:11:51

@membphis membphis added the doc Documentation things label Nov 3, 2020
Copy link
Contributor Author

@HelloBug0 HelloBug0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change tabs to spaces

Copy link
Member

@membphis membphis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can update the English version too

$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
{
"uri": "/route1",
"methods": ["PUT", "GET"],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can remove this line, it is not important

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your comments, and here you mean remove from line 61 to line 81?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only remove "methods": ["PUT", "GET"], ^_^

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I will remove it now~


## 启用插件

1. 配置文件apisix/conf/conf.yaml的plugins list中配置node-status
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file name of conf.yaml is incorrect, it should be config.yaml, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I will change it. Thanks~


## 插件接口

插件增加接口`/apisix/status`,可通过 [interceptors](plugin-interceptors.md)保护该接口。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need a space after interceptors.md)

}'
```

发送该请求的前提是apisix/conf/conf.yaml中已经配置node-status,此时node-status插件对该请求处理无影响,所以一般不会将node-status插件设置到路由中。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean apisix/conf/config.yaml? Also, need spaces between Chinese and English word.
Please fix other similar places in the PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, Thanks~

@HelloBug0 HelloBug0 changed the title doc: node-status.md docs: node-status.md Nov 4, 2020
@HelloBug0
Copy link
Contributor Author

I miss adding the commment when I commit the document at the third time, sorry about it.
I update this document according to the comments except this. I will change it later after making sure about it.
I really appreciate all your comments.

Copy link
Member

@membphis membphis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, except minor things

1. add a blank line after #目录
2. remove some unnecessary lines
1. add language type in code
2. change '插件属性为空' to ‘无’
3. change '接口插件' to '插件接口' which could add link to directory '插件接口'
Copy link
Member

@juzhiyuan juzhiyuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@juzhiyuan juzhiyuan merged commit 3ab580f into apache:master Nov 6, 2020
@spacewander
Copy link
Member

@HelloBug0
Wait for your English one 😃

@juzhiyuan
Copy link
Member

Tracking issue #2379

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation things

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants