liuxiran commented on issue #1039:
URL: 
https://github.com/apache/apisix-dashboard/issues/1039#issuecomment-783550440


   > I have a little doubt, where does the configuration template come from? 
And how do we maintain them. Thanks. @liuxiran
   
   The configuration template plans to define manually in a new dir e.g: 
`plugin_templates` in dashboard repo, and we have to maintain them when the 
configuration rules of the plugin changed.
   
   The template would contain three parts:
   1. `usage scenario`, which means if users want to use plugin in scenarioA, 
the can refer scenarioA's template  to complete their configuration.
   Just take `limit-count` for example:
   
![image](https://user-images.githubusercontent.com/2561857/108744919-7802b980-7575-11eb-8d18-93e8b265c1a8.png)
   
   `cluster-level precision traffic limit` is one of the scenarios for 
`limit-count` plugin. we want to extract the common usage scenarios indicated 
in the document to generate different `template`.
   For some plugins only have one usage scenario, then we would support 
something called `Universal configuration` template for them.
   Maybe there are no specific usage scenarios labeled in the document for some 
plugins, then we have to add them for better use.
   
   2. `description of the parameters`, which means add comments for every 
config item, user can config the plugin refer the comments instead of opening 
the doc page. 
   
   3. `default value of the parameters`, which means the recommended config(or 
recommended config policy) for the config item in the target usage scenario


----------------------------------------------------------------
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:
[email protected]


Reply via email to