[DOC] rewrite detail document for all plugin
This issue is to improve our home website plugin document. With our new document, everyone can easily know and use our native plugin:
-
this issue from https://github.com/apache/incubator-shenyu-website/issues/471#issue-1159451349
-
please test plugin and rewrite document.
-
New Plugin Document Template:
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
- [x] Authentication-Sign plugin @moremind 8.14
- [x] Authentication-Jwt Plugin @moremind
- [ ] Authentication-Oauth2 Plugin
- [ ] Authentication-Waf Plugin
- [x] FaultTolerance-Ratelimiter Plugin @moremind
- [x] FaultTolerance-Hystrix Plugin @moremind 8.12
- [x] FaultTolerance-Sentinel Plugin @moremind
- [ ] FaultTolerance-Resilience4j Plugin
- [x] HttpProcess-ParamMapping Plugin @weopen-star @moremind
- [x] HttpProcess-ContextPath Plugin @AhahaGe finished
- [x] HttpProcess-Rewrite Plugin @weopen-star @Albertsirius
- [x] HttpProcess-Redirect Plugin @weopen-star
- [x] HttpProcess-Request Plugin @lahmXu
- [x] HttpProcess-ModifyResponse Plugin @weopen-star @zjcscut
- [ ] Proxy-Mqtt Plugin
- [x] Proxy-SpringCloud Plugin @moremind
- [x] Proxy-Websocket Plugin @lahmXu
- [x] Proxy-Divide Plugin @AhahaGe
- [ ] Proxy-Grpc Plugin
- [ ] Proxy-Motan Plugin
- [x] Proxy-Tars Plugin @lahmXu
- [x] Proxy-Sofa Plugin @lahmXu
- [ ] Proxy-Dubbo Plugin @moremind
- [ ] Common-GeneralContext Plugin
- [x] Logging-Loggin Plugin @moremind
- [ ] Monitor-Monitor Plugin
- [x] Logging-Logging-RocketMQ Plugin @moremind
- [x] Logging-Logging-Kafka Plugin @qifanyyy
- [x] Logging-Logging-ElasticSearch Plugin @moremind
- [x] Logging-Logging-Aliyunsls Plugin @moremind
- [x] Mock Plugin @LiuTianyou
- [x] Cache Plugin @moremind
- [x] logging cls plugin @yunlongn
- [ ] logging clickhouse plugin @misaya295
- [x] logging pulsar plugin @LeBW
spring cloud and dubbo will update in next week.
Please assign the [Proxy-Websocket Plugin] to me, thanks!
I have already updated [HttpProcess-ModifyResponse Plugin] doc and the PR is merged, thx
assigned logging clickhouse plugin pls
assigned logging clickhouse plugin pls
Already assigned, looking forward to your contribution.