Skip to content

[WeOpen-Star] Optimize ShenYu Redirect Plugin Document #678

@moremind

Description

@moremind

How to Participation

Please reply [WeOpen Star]I would like to help and task number to get the task.

After Pull Request Merged

pls add wechat: 腾小源, note : 摘星

Description

  • Optimize ShenYu Redirect Plugin Document

Task

How to do it

  • you can do this with document template. and you can add other content not only this template.

  • you should add this plugin docment in version doc with en and zh.

  • 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
  • Chinese Document
  ## 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. 如何禁用插件

How to contribute

You can see this : Contributor Guide

I suggest you subscribe to shenyu dev mailing list, and when you encounter any problems, or when you finish,
you can send an email to dev@shenyu.apache.org

Verification

After you modify file ,You verify local and you can see this : How to build shenyu website .

After you pull request merged. You can verify to this : en-doc , zh-doc

How to Participation

  1. reply: [WeOpen Star]I would like to help
  2. add this wechat. note : 摘星

image

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions