Re:Plugin document template

[AhahaGe]

Hi community, 


Thanks for your great feedback.


I added 1.5 code galance, 2.4 for complex comfig can show the key config class 
and 3. how to remove(close) plugin.
Is it ok?




Overview:

        1.1 name of this plugin

        1.2 used for which scenario to solve what problem

        1.3 contains what functionality

        1.4 added since which shenyu version
        1.5 code galance, related projects, key code class.
How to use this plugin.

        2.1 the central procedure mainly for some complex plugin

        2.2 import pom

        2.3 enable plugin

        2.4 config plugin: describe every page config item so that everyone 
knows config detail, can contain examples and picture, for complex comfig can 
show the key config class

        2.5 examples

           2.5.1 examples1, text and snapshot, detail describe every page 
config item, request, result

           2.5.2 examples2, text and snapshot, detail describe every page 
config item, request, result

How to remove(close) this plugin.
        3.1 disable plugin







At 2022-03-18 19:57:11, "AhahaGe" <ahah...@163.com> wrote:

Hi community, 




     I created a 
issue(https://github.com/apache/incubator-shenyu-website/issues/471) detail 
document for all plugin which aims to improve our home website plugin document. 

     With our new document, everyone can easily know and use our native plugin.

     I defined the new Plugin Document Template,  please fell free to give me 
more advices. 
     After template is fixed, welcome everyone to contribute together, and 
devlelopers of plugins help review document.

     

     Overview:

        1.1 name of this plugin

        1.2 used for which scenario to solve what problem

        1.3 contains what functionality

        1.4 added since which shenyu version

     How to use this plugin.

        2.1 the central procedure mainly for some complex plugin

        2.2 import pom

        2.3 enable plugin

        2.4 config plugin: describe every page config item so that everyone 
knows config detail, can contain examples and picture

        2.5 examples

           2.5.1 examples1, text and snapshot, detail describe every page 
config item, request, result

           2.5.2 examples2, text and snapshot, detail describe every page 
config item, request, result

     

     We welcome users to provide best practice to give us more ideas or help us 
improve specific native plugin.







Thanks

AhahaGe