-
Notifications
You must be signed in to change notification settings - Fork 235
Open
Description
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 [DOC] detail document for all plugin #471 (comment)
-
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
- Authentication-Sign plugin @moremind 8.14
- Authentication-Jwt Plugin @moremind
- Authentication-Oauth2 Plugin
- Authentication-Waf Plugin
- FaultTolerance-Ratelimiter Plugin @moremind
- FaultTolerance-Hystrix Plugin @moremind 8.12
- FaultTolerance-Sentinel Plugin @moremind
- FaultTolerance-Resilience4j Plugin
- HttpProcess-ParamMapping Plugin @weopen-star @moremind
- HttpProcess-ContextPath Plugin @AhahaGe finished
- HttpProcess-Rewrite Plugin @weopen-star @Albertsirius
- HttpProcess-Redirect Plugin @weopen-star
- HttpProcess-Request Plugin @lahmXu
- HttpProcess-ModifyResponse Plugin @weopen-star @zjcscut
- Proxy-Mqtt Plugin
- Proxy-SpringCloud Plugin @moremind
- Proxy-Websocket Plugin @lahmXu
- Proxy-Divide Plugin @AhahaGe
- Proxy-Grpc Plugin
- Proxy-Motan Plugin
- Proxy-Tars Plugin @lahmXu
- Proxy-Sofa Plugin @lahmXu
- Proxy-Dubbo Plugin @moremind
- Common-GeneralContext Plugin
- Logging-Loggin Plugin @moremind
- Monitor-Monitor Plugin
- Logging-Logging-RocketMQ Plugin @moremind
- Logging-Logging-Kafka Plugin @qifanyyy
- Logging-Logging-ElasticSearch Plugin @moremind
- Logging-Logging-Aliyunsls Plugin @moremind
- Mock Plugin @LiuTianyou
- Cache Plugin @moremind
- logging cls plugin @yunlongn
- logging clickhouse plugin @misaya295
- logging pulsar plugin @LeBW