search

apache / shenyu-website

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

[DOC] rewrite detail document for all plugin #614

Open moremind opened 2 years ago

moremind 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:

English Document:

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

  1. [x] Authentication-Sign plugin @moremind 8.14
  2. [x] Authentication-Jwt Plugin @moremind
  3. [ ] Authentication-Oauth2 Plugin
  4. [ ] Authentication-Waf Plugin
  5. [x] FaultTolerance-Ratelimiter Plugin @moremind
  6. [x] FaultTolerance-Hystrix Plugin @moremind 8.12
  7. [x] FaultTolerance-Sentinel Plugin @moremind
  8. [ ] FaultTolerance-Resilience4j Plugin
  9. [x] HttpProcess-ParamMapping Plugin @weopen-star @moremind
  10. [x] HttpProcess-ContextPath Plugin @AhahaGe finished
  11. [x] HttpProcess-Rewrite Plugin @weopen-star @Albertsirius
  12. [x] HttpProcess-Redirect Plugin @weopen-star
  13. [x] HttpProcess-Request Plugin @lahmXu
  14. [x] HttpProcess-ModifyResponse Plugin @weopen-star @zjcscut
  15. [ ] Proxy-Mqtt Plugin
  16. [x] Proxy-SpringCloud Plugin @moremind
  17. [x] Proxy-Websocket Plugin @lahmXu
  18. [x] Proxy-Divide Plugin @AhahaGe
  19. [ ] Proxy-Grpc Plugin
  20. [ ] Proxy-Motan Plugin
  21. [x] Proxy-Tars Plugin @lahmXu
  22. [x] Proxy-Sofa Plugin @lahmXu
  23. [ ] Proxy-Dubbo Plugin @moremind
  24. [ ] Common-GeneralContext Plugin
  25. [x] Logging-Loggin Plugin @moremind
  26. [ ] Monitor-Monitor Plugin
  27. [x] Logging-Logging-RocketMQ Plugin @moremind
  28. [x] Logging-Logging-Kafka Plugin @qifanyyy
  29. [x] Logging-Logging-ElasticSearch Plugin @moremind
  30. [x] Logging-Logging-Aliyunsls Plugin @moremind
  31. [x] Mock Plugin @LiuTianyou
  32. [x] Cache Plugin @moremind
  33. [x] logging cls plugin @yunlongn
  34. [ ] logging clickhouse plugin @misaya295
  35. [x] logging pulsar plugin @LeBW
moremind commented 2 years ago

spring cloud and dubbo will update in next week.

lahmXu commented 2 years ago

Please assign the [Proxy-Websocket Plugin] to me, thanks!

zjcscut commented 2 years ago

I have already updated [HttpProcess-ModifyResponse Plugin] doc and the PR is merged, thx

misaya295 commented 1 year ago

assigned logging clickhouse plugin pls

lahmXu commented 1 year ago

assigned logging clickhouse plugin pls

Already assigned, looking forward to your contribution.