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/12/25 06:23:16 UTC
[GitHub] [apisix] spacewander opened a new pull request #3125: docs: improve the plugin-develop doc
spacewander opened a new pull request #3125:
URL: https://github.com/apache/apisix/pull/3125
Signed-off-by: spacewander <sp...@gmail.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. -->
### 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?
* [x] Have you modified the corresponding document?
* [ ] 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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on a change in pull request #3125: docs: improve the plugin-develop doc
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #3125:
URL: https://github.com/apache/apisix/pull/3125#discussion_r549010074
##########
File path: doc/plugin-develop.md
##########
@@ -113,9 +113,9 @@ Write [Json Schema](https://json-schema.org) descriptions and check functions. S
```json
"example-plugin" : {
- i = 1,
- s = "s",
- t = {1}
+ "i": 1,
+ "s": "s",
+ "t": {1}
Review comment:
@dabue
Solved.
----------------------------------------------------------------
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] [apisix] nic-chen commented on a change in pull request #3125: docs: improve the plugin-develop doc
Posted by GitBox <gi...@apache.org>.
nic-chen commented on a change in pull request #3125:
URL: https://github.com/apache/apisix/pull/3125#discussion_r548923262
##########
File path: doc/plugin-develop.md
##########
@@ -106,33 +108,41 @@ $(INSTALL) apisix/plugins/skywalking/*.lua $(INST_LUADIR)/apisix/plugins/skywalk
## schema and check
-Write [Json Schema](https://json-schema.org) descriptions and check functions. similarly, take the key-auth plugin as an example to see its
+Write [Json Schema](https://json-schema.org) descriptions and check functions. Similarly, take the example-plugin plugin as an example to see its
configuration data :
```json
- "key-auth" : {
- "key" : "auth-one"
- }
+"example-plugin" : {
+ i = 1,
+ s = "s",
+ t = {1}
+}
Review comment:
it should be json here，not lua table ？
----------------------------------------------------------------
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] [apisix] spacewander commented on a change in pull request #3125: docs: improve the plugin-develop doc
Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #3125:
URL: https://github.com/apache/apisix/pull/3125#discussion_r548927856
##########
File path: doc/plugin-develop.md
##########
@@ -106,33 +108,41 @@ $(INSTALL) apisix/plugins/skywalking/*.lua $(INST_LUADIR)/apisix/plugins/skywalk
## schema and check
-Write [Json Schema](https://json-schema.org) descriptions and check functions. similarly, take the key-auth plugin as an example to see its
+Write [Json Schema](https://json-schema.org) descriptions and check functions. Similarly, take the example-plugin plugin as an example to see its
configuration data :
```json
- "key-auth" : {
- "key" : "auth-one"
- }
+"example-plugin" : {
+ i = 1,
+ s = "s",
+ t = {1}
+}
Review comment:
@nic-chen
Solved.
----------------------------------------------------------------
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] [apisix] dabue commented on a change in pull request #3125: docs: improve the plugin-develop doc
Posted by GitBox <gi...@apache.org>.
dabue commented on a change in pull request #3125:
URL: https://github.com/apache/apisix/pull/3125#discussion_r548984623
##########
File path: doc/plugin-develop.md
##########
@@ -113,9 +113,9 @@ Write [Json Schema](https://json-schema.org) descriptions and check functions. S
```json
"example-plugin" : {
- i = 1,
- s = "s",
- t = {1}
+ "i": 1,
+ "s": "s",
+ "t": {1}
Review comment:
I thougt you want to use "t":[1] .
----------------------------------------------------------------
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] [apisix] jbampton commented on a change in pull request #3125: docs: improve the plugin-develop doc
Posted by GitBox <gi...@apache.org>.
jbampton commented on a change in pull request #3125:
URL: https://github.com/apache/apisix/pull/3125#discussion_r548869892
##########
File path: doc/plugin-develop.md
##########
@@ -106,33 +108,41 @@ $(INSTALL) apisix/plugins/skywalking/*.lua $(INST_LUADIR)/apisix/plugins/skywalk
## schema and check
-Write [Json Schema](https://json-schema.org) descriptions and check functions. similarly, take the key-auth plugin as an example to see its
+Write [Json Schema](https://json-schema.org) descriptions and check functions. similarly, take the example-plugin plugin as an example to see its
Review comment:
```suggestion
Write [Json Schema](https://json-schema.org) descriptions and check functions. Similarly, take the example-plugin plugin as an example to see its
```
----------------------------------------------------------------
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] [apisix] spacewander merged pull request #3125: docs: improve the plugin-develop doc
Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #3125:
URL: https://github.com/apache/apisix/pull/3125
----------------------------------------------------------------
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