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 2022/01/16 13:56:33 UTC

[GitHub] [apisix] kerneltravel opened a new pull request #6122: add demonstration of log config of "nginx_config" in docs.

kerneltravel opened a new pull request #6122:
URL: https://github.com/apache/apisix/pull/6122


   ### What this PR does / why we need it:
   add demonstration in log format of nginx_config customization for somebody who need an example of this subject.
   and fixed the original incorrect indents.
   [<!--- If it fixes an open issue, please link to the issue here. -->](https://github.com/apache/apisix/issues/6072)
   
   ### Pre-submission checklist:
   
   <!--
   Please follow the PR manners:
   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. If you need to resolve merge conflicts after the PR is reviewed, please merge master but do not rebase
   6. Use "request review" to notify the reviewer once you have resolved the review
   7. Only reviewer can click "Resolve conversation" to mark the reviewer's review resolved
   -->
   
   * [ ] 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? **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] spacewander commented on pull request #6122: add demonstration of log config of "nginx_config" in docs.

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


   @kerneltravel 
   Anyway, I think the suggestion below is worthwhile.
   
   > Pay attention to the indent of `nginx_config` and sub indent of the sub entries, the incorrect indent may cause `./bin/apisix start` to fail to generate Nginx configuration in `conf/nginx.conf`.
   
   Would you mind just submitting this phrase in another PR? Thanks!


-- 
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 #6122: add demonstration of log config of "nginx_config" in docs.

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



##########
File path: docs/en/latest/customize-nginx-configuration.md
##########
@@ -25,37 +25,78 @@ The Nginx configuration used by APISIX is generated via the template file `apisi
 
 You can take a look at the generated Nginx configuration in `conf/nginx.conf` after running `./bin/apisix start`.
 
-If you want to customize the Nginx configuration, please read through the `nginx_config` in `conf/config-default.yaml`. You can override the default value in the `conf/config.yaml`. For instance, you can inject some snippets in the `conf/nginx.conf` via configuring the `xxx_snippet` entries:
+If you want to customize the Nginx configuration, please read through the `nginx_config` in `conf/config-default.yaml`. You can override the default value in the `conf/config.yaml`. For instance, you can custum access_log_format via configuring the `http` entries; you can inject some snippets in the `conf/nginx.conf` via configuring the `xxx_snippet` entries:
 
 ```yaml
 ...
 # put this in config.yaml:
 nginx_config:
-    main_configuration_snippet: |

Review comment:
       I don't think the original indent (4 spaces) 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.

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 edited a comment on pull request #6122: add demonstration of log config of "nginx_config" in docs.

Posted by GitBox <gi...@apache.org>.
leslie-tsang edited a comment on pull request #6122:
URL: https://github.com/apache/apisix/pull/6122#issuecomment-1013881711


   Hello there, Can you add a text like `fix #6072` in PR desc, it help reviewer to sync the status between issues and PR.


-- 
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 pull request #6122: add demonstration of log config of "nginx_config" in docs.

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


   There is no need to put everything into the documentation. We just document what's critical, otherwise the doc is too long to read.


-- 
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 closed pull request #6122: add demonstration of log config of "nginx_config" in docs.

Posted by GitBox <gi...@apache.org>.
spacewander closed pull request #6122:
URL: https://github.com/apache/apisix/pull/6122


   


-- 
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 edited a comment on pull request #6122: add demonstration of log config of "nginx_config" in docs.

Posted by GitBox <gi...@apache.org>.
leslie-tsang edited a comment on pull request #6122:
URL: https://github.com/apache/apisix/pull/6122#issuecomment-1013881711


   Hello there, Can you add a test like `fix #6072` in PR desc, it help reviewer to sync the status between issues and PR.


-- 
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 pull request #6122: add demonstration of log config of "nginx_config" in docs.

Posted by GitBox <gi...@apache.org>.
leslie-tsang commented on pull request #6122:
URL: https://github.com/apache/apisix/pull/6122#issuecomment-1013881711


   Hello there, Can you add a test like `fix #6072` in PR desc, it help reviewer to sync status between issues and PR.


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