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/01/05 10:01:42 UTC

[GitHub] [apisix] membphis opened a new issue #3195: docs: need a better doc style for developer

membphis opened a new issue #3195:
URL: https://github.com/apache/apisix/issues/3195


   https://github.com/apache/apisix/blob/master/doc/plugins/traffic-split.md
   
   It's hard to read.
   
   ![image](https://user-images.githubusercontent.com/6814606/103632749-c0dbc000-4f7f-11eb-942f-fe9f926bc82a.png)
   


----------------------------------------------------------------
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] moonming closed issue #3195: docs: need a better doc style for developer

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


   


----------------------------------------------------------------
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] moonming closed issue #3195: docs: need a better doc style for developer

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


   


----------------------------------------------------------------
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 edited a comment on issue #3195: docs: need a better doc style for developer

Posted by GitBox <gi...@apache.org>.
Firstsawyou edited a comment on issue #3195:
URL: https://github.com/apache/apisix/issues/3195#issuecomment-754548095


   > @Firstsawyou Do you have any advice?
   
   We need to adjust the length of the `Name` field in `Attributes`. Just keep the main part. For example, `rules.weighted_upstreams.upstream.upstream_host` we can change to `upstream.upstream_host`. Because they all have the same `rules.weighted_upstreams` part.
   
   I think the final form:
   
   | Name             | 
   | ---------------- |
   | rules.match      | 
   | rules.match.vars |
   | rules.weighted_upstreams  | 
   | weighted_upstreams.upstream_id  |
   | weighted_upstreams.upstream   | 
   | upstream.type | 
   | upstream.nodes  |
   | upstream.timeout  |
   | upstream.pass_host |
   | upstream.name      |
   | upstream.upstream_host |
   | weighted_upstreams.weight |
   
   This is more clear. 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] membphis commented on issue #3195: docs: need a better doc style for developer

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


   Here is the reason:
   
   ![image](https://user-images.githubusercontent.com/6814606/103633131-45c6d980-4f80-11eb-9261-c7072b5ba711.png)
   


----------------------------------------------------------------
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 issue #3195: docs: need a better doc style for developer

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


   @Firstsawyou Do you have any advice?


----------------------------------------------------------------
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 #3195: docs: need a better doc style for developer

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


   > @Firstsawyou Do you have any advice?
   
   We need to adjust the length of the `Name` field in `Attributes`. Just keep the main part. For example, `rules.weighted_upstreams.upstream.upstream_host` we can change to `upstream.upstream_host`. Because they all have the same `rules.weighted_upstreams` part.
   
   I think the final form:
   
   | Name             | 
   | ---------------- |
   | match      | 
   | match.vars |
   | weighted_upstreams  | 
   | upstream_id  |
   | upstream   | 
   | upstream.type | 
   | upstream.nodes  |
   | upstream.timeout  |
   | upstream.pass_host |
   | upstream.name      |
   | upstream.upstream_host |
   | weight |
   
   This is more clear. 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