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/10/18 13:35:30 UTC

[GitHub] [apisix] dabue opened a new pull request #2458: [doc]to correct some typo and incorrect examples in getting-started.md and syslog.md

dabue opened a new pull request #2458:
URL: https://github.com/apache/apisix/pull/2458


   ### What this PR does / why we need it:
   <!--- Why is this change required? What problem does it solve? -->
   fix #2457 
   ### Pre-submission checklist:
   https://github.com/apache/apisix/blob/master/doc/getting-started.md#add-a-prefix-to-the-route Line 240
   should be replaced with
   curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H 'apikey: superSecretAPIKey'
   
   the example in  https://github.com/apache/apisix/blob/master/doc/plugins/syslog.md#how-to-enable should be for route not consumers and the value is wrong.


----------------------------------------------------------------
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] membphis commented on a change in pull request #2458: [doc]to correct some typo and incorrect examples in getting-started.md and syslog.md

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



##########
File path: doc/getting-started.md
##########
@@ -237,7 +237,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f13
 Now you can invoke the route with the following command:
 
 ```bash
-curl -i -X GET http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar -H 'apikey: superSecretAPIKey'
+curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H 'apikey: superSecretAPIKey'

Review comment:
       ping @dabue what do you think?




----------------------------------------------------------------
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 pull request #2458: [doc]to correct some typo and incorrect examples in getting-started.md and syslog.md

Posted by GitBox <gi...@apache.org>.
dabue commented on pull request #2458:
URL: https://github.com/apache/apisix/pull/2458#issuecomment-717676409


   @membphis  please have a reviee, thx.


----------------------------------------------------------------
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 #2458: [doc]to correct some typo and incorrect examples in getting-started.md and syslog.md

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



##########
File path: doc/getting-started.md
##########
@@ -237,7 +237,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f13
 Now you can invoke the route with the following command:
 
 ```bash
-curl -i -X GET http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar -H 'apikey: superSecretAPIKey'
+curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H 'apikey: superSecretAPIKey'

Review comment:
       got it

##########
File path: doc/plugins/syslog.md
##########
@@ -57,25 +57,22 @@ This will provide the ability to send Log data requests as JSON objects.
 The following is an example on how to enable the sys-logger for a specific route.
 
 ```shell
-curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '

Review comment:
       lgtm




----------------------------------------------------------------
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] membphis merged pull request #2458: [doc]to correct some typo and incorrect examples in getting-started.md and syslog.md

Posted by GitBox <gi...@apache.org>.
membphis merged pull request #2458:
URL: https://github.com/apache/apisix/pull/2458


   


----------------------------------------------------------------
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 #2458: [doc]to correct some typo and incorrect examples in getting-started.md and syslog.md

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



##########
File path: doc/zh-cn/getting-started.md
##########
@@ -232,7 +232,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f13
 现在可以使用以下命令调用路由：
 
 ```bash
-curl -i -X GET http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar -H 'apikey: superSecretAPIKey'
+curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H 'apikey: superSecretAPIKey'

Review comment:
       got it




----------------------------------------------------------------
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] membphis commented on a change in pull request #2458: [doc]to correct some typo and incorrect examples in getting-started.md and syslog.md

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



##########
File path: doc/getting-started.md
##########
@@ -237,7 +237,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f13
 Now you can invoke the route with the following command:
 
 ```bash
-curl -i -X GET http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar -H 'apikey: superSecretAPIKey'
+curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H 'apikey: superSecretAPIKey'

Review comment:
       I prefer to use `'` in this case, the same as `-H`.

##########
File path: doc/plugins/syslog.md
##########
@@ -57,25 +57,22 @@ This will provide the ability to send Log data requests as JSON objects.
 The following is an example on how to enable the sys-logger for a specific route.
 
 ```shell
-curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '

Review comment:
       nice catch

##########
File path: doc/zh-cn/getting-started.md
##########
@@ -232,7 +232,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f13
 现在可以使用以下命令调用路由：
 
 ```bash
-curl -i -X GET http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar -H 'apikey: superSecretAPIKey'
+curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar" -H 'apikey: superSecretAPIKey'

Review comment:
       ditto




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