-
Notifications
You must be signed in to change notification settings - Fork 223
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOC] detail document for all plugin #471
Comments
@AhahaGe Hi, I would like to participate in this and submit the documentation of the Chinese version of the Hystrix plugin in the near future. I will add the English version of the document after your review. Is this okay? And I think you can add tags like volunteer needed, good first issue. Attract new contributors to contribute. |
Thanks for your contribute. |
good idea |
@AhahaGe Hi, I would like to pick up the Proxy-Mqtt Plugin |
please assign sentinel and logging plugin for me. |
Assigned, thanks for your contribute and looking forward to your pr, any problem need help can communicate by community mail. |
ok, I will finish it in two weeks. |
Sorry, I've been busy lately,I will update sentinel in next week. |
I just finished logggingConsole plugin document. |
Thanks |
Pls assign 'proxy springcloud & websocket' to me.Btw, tell me the one for help. |
This issue is to improve our home website plugin document.
With our new document, everyone can easily know and use our native plugin:
New Plugin Document Template:
Overview
1.1 Plugin Name
1.2 Appropriate Scenario
1.3 Plugin functionality
1.4 Plugin code
1.5 Added Since Which shenyu version
How to use plugin
2.1 Plugin-use procedure chart
2.2 Import pom
2.3 Enable plugin
2.4 Config plugin
key config class
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
How to disable plugin
概述:
1.1 插件名称
1.2 适用场景
1.3 插件功能
1.4 插件代码
1.5 添加自哪个shenyu版本
如何使用插件
2.1 插件使用流程图
2.2 导入pom
2.3 启用插件
2.4 配置插件
2.5 示例
2.5.1 示例1,文本和快照,详细描述每个页面配置项,请求,结果
2.5.2 示例2,文本和快照,详细描述每个页面配置项,请求,结果
如何禁用插件
We welcome users to provide best practice to give us more ideas or help us improve specific native plugin.
The text was updated successfully, but these errors were encountered: