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 2021/04/01 03:44:49 UTC

[GitHub] [apisix] Firstsawyou opened a new issue #3962: [discuss]: how to make the comments in the config-default.yaml file clearer

Firstsawyou opened a new issue #3962:
URL: https://github.com/apache/apisix/issues/3962


   Description:
   
   Currently, the comment style in the config-default.yaml file is very misleading, for example:
   
   ```yaml
   router:
     http: 'radixtree_uri'         # radixtree_uri: match route by uri(base on radixtree)
                                     # radixtree_host_uri: match route by host + uri(base on radixtree)
                                     # radixtree_uri_with_parameter: like radixtree_uri but match uri with parameters,
                                     #   see https://github.com/api7/lua-resty-radixtree/#parameters-in-path for
                                     #   more details.
     ssl: 'radixtree_sni'          # radixtree_sni: match route by SNI(base on radixtree)
   # stream_proxy:                 # TCP/UDP proxy
   #   tcp:             
   ```
   This comment style is easy to understand that `stream_proxy` is at the same level as `ssl`, but `stream_proxy` is at the same level as `router`.
   I think we need a better way of annotation to make it easier for users to understand the hierarchical relationship before them.
   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] Firstsawyou commented on issue #3962: [discuss]: how to make the annotations in the config-default.yaml file clearer

Posted by GitBox <gi...@apache.org>.
Firstsawyou commented on issue #3962:
URL: https://github.com/apache/apisix/issues/3962#issuecomment-811864716


   Agree, the style of `#app` looks better.


-- 
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 issue #3962: [discuss]: how to make the annotations in the config-default.yaml file clearer

Posted by GitBox <gi...@apache.org>.
spacewander commented on issue #3962:
URL: https://github.com/apache/apisix/issues/3962#issuecomment-811683198


   The `# ` style of comment is used because the yamllint requires it.
   Maybe we can use `#app` style for commented out configuration, like this:
   https://github.com/elastic/beats/blob/1f1fae56057dce0604f72f2cf0099f9a6f2b75aa/filebeat/filebeat.reference.yml#L29
   
   We can also remove the yamllint as there is almost nothing left that can be linted.


-- 
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 closed issue #3962: [discuss]: how to make the annotations in the config-default.yaml file clearer

Posted by GitBox <gi...@apache.org>.
spacewander closed issue #3962:
URL: https://github.com/apache/apisix/issues/3962


   


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