Skip to content

[DOC] rewrite detail document for all plugin #614

@moremind

Description

@moremind

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.

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

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions