Skip to content
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

Open
2 of 26 tasks
AhahaGe opened this issue Mar 4, 2022 · 12 comments
Open
2 of 26 tasks

[DOC] detail document for all plugin #471

AhahaGe opened this issue Mar 4, 2022 · 12 comments
Assignees

Comments

@AhahaGe
Copy link
Contributor

AhahaGe commented Mar 4, 2022

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

  4. 概述:
    1.1 插件名称
    1.2 适用场景
    1.3 插件功能
    1.4 插件代码
    1.5 添加自哪个shenyu版本

  5. 如何使用插件
    2.1 插件使用流程图
    2.2 导入pom
    2.3 启用插件
    2.4 配置插件
    2.5 示例
    2.5.1 示例1,文本和快照,详细描述每个页面配置项,请求,结果
    2.5.2 示例2,文本和快照,详细描述每个页面配置项,请求,结果

  6. 如何禁用插件

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

  • Authentication-Sign plugin blocked for bug
  • Authentication-Jwt Plugin
  • Authentication-Oauth2 Plugin
  • Authentication-Waf Plugin
  • FaultTolerance-Ratelimiter Plugin
  • FaultTolerance-Hystrix Plugin @erdengk
  • FaultTolerance-Sentinel Plugin @moremind
  • FaultTolerance-REsilience4j Plugin
  • HttpProcess-ParamMapping Plugin
  • HttpProcess-ContextPath Plugin @AhahaGe finished
  • HttpProcess-Rewrite Plugin
  • HttpProcess-Redirect Plugin
  • HttpProcess-Request Plugin
  • HttpProcess-ModifyResponse Plugin
  • Proxy-Mqtt Plugin @selectbook
  • Proxy-SpringCloud Plugin
  • Proxy-Websocket Plugin
  • Proxy-Divide Plugin @AhahaGe
  • Proxy-Grpc Plugin
  • Proxy-Motan Plugin
  • Proxy-Tars Plugin
  • Proxy-Sofa Plugin
  • Proxy-Dubbo Plugin
  • Common-GeneralContext Plugin
  • Logging-Loggin Plugin @moremind
  • Monitor-Monitor Plugin
@erdengk
Copy link
Contributor

erdengk commented Mar 12, 2022

@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
Copy link
Contributor Author

AhahaGe commented Mar 14, 2022

Thanks for your contribute.

@midnight2104
Copy link
Contributor

good idea

yu199195 pushed a commit that referenced this issue Mar 29, 2022
* apache dubbo example doc for version 2.4.0 and 2.4.1

* [DOC] add shenyu.httpclient config param in doc both en and cn #470

* contextPath plugin

* [DOC] rewrite context-path plugin document.
yu199195 pushed a commit that referenced this issue Apr 1, 2022
…525)

* apache dubbo example doc for version 2.4.0 and 2.4.1

* [DOC] add shenyu.httpclient config param in doc both en and cn #470

* add context path doc for remaining version
@selectbook
Copy link

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

@AhahaGe
Copy link
Contributor Author

AhahaGe commented Apr 19, 2022

@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
Copy link
Member

please assign sentinel and logging plugin for me.

@AhahaGe
Copy link
Contributor Author

AhahaGe commented May 5, 2022

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
Copy link
Member

moremind commented May 5, 2022

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
Copy link
Member

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

@moremind
Copy link
Member

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

I just finished logggingConsole plugin document.

@AhahaGe AhahaGe removed their assignment May 17, 2022
@AhahaGe
Copy link
Contributor Author

AhahaGe commented May 17, 2022

Thanks

@damonxue
Copy link
Contributor

damonxue commented Jun 7, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants