apache / shenyu-website

Apache ShenYu website.
https://shenyu.apache.org/
Apache License 2.0
72 stars 217 forks source link

[DOC] detail document for all plugin #471

Open AhahaGe opened 2 years ago

AhahaGe commented 2 years ago

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:

  1. Overview 1.1 Plugin Name 1.2 Appropriate Scenario 1.3 Plugin functionality 1.4 Plugin code 1.5 Added Since Which shenyu version
  2. 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
  3. How to disable plugin
  1. 概述: 1.1 插件名称 1.2 适用场景 1.3 插件功能 1.4 插件代码 1.5 添加自哪个shenyu版本
  2. 如何使用插件 2.1 插件使用流程图 2.2 导入pom 2.3 启用插件 2.4 配置插件 2.5 示例 2.5.1 示例1,文本和快照,详细描述每个页面配置项,请求,结果 2.5.2 示例2,文本和快照,详细描述每个页面配置项,请求,结果
  3. 如何禁用插件

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

erdengk commented 2 years ago

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

AhahaGe commented 2 years ago

Thanks for your contribute.

midnight2104 commented 2 years ago

good idea

selectbook commented 2 years ago

@AhahaGe Hi, I would like to pick up the Proxy-Mqtt Plugin

AhahaGe commented 2 years ago

@AhahaGe Hi, I would like to pick up the Proxy-Mqtt Plugin

When writing this plugin, you can ask @impactCn and other members for help. And you can refer context-path, as it's written according to new template. Thanks for your contribute. Looking forward to your pr.

moremind commented 2 years ago

please assign sentinel and logging plugin for me.

AhahaGe commented 2 years ago

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.

moremind commented 2 years ago

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.

moremind commented 2 years ago

Sorry, I've been busy lately,I will update sentinel in next week.

moremind commented 2 years ago

Sorry, I've been busy lately,I will update sentinel in next week.

I just finished logggingConsole plugin document.

AhahaGe commented 2 years ago

Thanks

damonxue commented 2 years ago

Pls assign 'proxy springcloud & websocket' to me.Btw, tell me the one for help.