Hi community,
I submit a pr https://github.com/apache/incubator-shenyu-website/pull/521
for context-path plugin document which followed the template in issue
https://github.com/apache/incubator-shenyu-website/issues/471.
As this is the first doc using the template, please help review it and
give me feedback.
After document one plugin, I knowed not only how to use this plugin ,
much much more I suggested before.
1. we may need to read code and communicate to author to help understand
logic and plugin design target.
2. Sometimes you will have a question why it's designed like this, can we
improve it.
3. Sometime you will have a question could we chagne or remove some
parameters.
3. Also you will know the relations among plugins, their execute
orders, how they combine together in handling requests.
4. Sometimes we may encount some errors during config plugin, you can ask
for help or fix it yourself.
And also write this plugin really cost time, almost 2 work days, though
this is only a simple plugin. And I suggest tag this issue good-first issue,
and ask more members to contribute together.
Many Thanks
Ahaha
在 2022-03-22 22:48:25，"AhahaGe" <[email protected]> 写道：
Hi community,
I added the chinese version template, please help review.
If it's ok, plugin writter's, such as cache plugin, please help follow the new
template, many thanks.
As sign plugin have some front error and blocked my document, I submmitted a
issue https://github.com/apache/incubator-shenyu/issues/3090, hope anyone can't
help fix it.
## 1. 概述
### 1.1 插件名称
* 签名
### 1.2 适用场景
* 当需要提升接口的安全性的时候
### 1.3 插件功能
* 对请求增加签名认证
### 1.4 插件代码
* 核心模块 ```shenyu-plugin-sign```
* 核心类 ```org.apache.shenyu.plugin.sign.SignPlugin```
### 1.5 添加自哪个 shenyu 版本
* 2.3.0
## 2. 如何使用插件
# 2.1 插件使用流程图
# 2.2 导入pom
# 2.3 启用插件
# 2.4 配置插件
# 2.5 示例
## 3. 如何禁用插件
At 2022-03-21 09:22:30, "AhahaGe" <[email protected]> wrote:
Hi community,
Thanks for your great feedback.
I added 1.5 code galance, 2.4 for complex comfig can show the key config class
and 3. how to remove(close) plugin.
Is it ok?
Overview:
1.1 name of this plugin
1.2 used for which scenario to solve what problem
1.3 contains what functionality
1.4 added since which shenyu version
1.5 code galance, related projects, key code class.
How to use this plugin.
2.1 the central procedure mainly for some complex plugin
2.2 import pom
2.3 enable plugin
2.4 config plugin: describe every page config item so that everyone
knows config detail, can contain examples and picture, for complex comfig can
show the key config class
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
How to remove(close) this plugin.
3.1 disable plugin
At 2022-03-18 19:57:11, "AhahaGe" <[email protected]> wrote:
Hi community,
I created a
issue(https://github.com/apache/incubator-shenyu-website/issues/471) detail
document for all plugin which aims to improve our home website plugin document.
With our new document, everyone can easily know and use our native plugin.
I defined the new Plugin Document Template, please fell free to give me
more advices.
After template is fixed, welcome everyone to contribute together, and
devlelopers of plugins help review document.
Overview:
1.1 name of this plugin
1.2 used for which scenario to solve what problem
1.3 contains what functionality
1.4 added since which shenyu version
How to use this plugin.
2.1 the central procedure mainly for some complex plugin
2.2 import pom
2.3 enable plugin
2.4 config plugin: 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
We welcome users to provide best practice to give us more ideas or help us
improve specific native plugin.
Thanks
AhahaGe
