Hi community,

According to the first idea, I defined a project according the template in 
https://summer-ospp.ac.cn/  . Please help review.


Project Name:
Apache Shenyu plugin document refactor.


Degree of Difficulty:
Advanced Level or Normal Level? Please help define the difficult level.


Labels of Techinal Field:
Cloud Native、Distributed、Pluggable、High-Performance、Flow Control、Rich protocols


Labels of Programming Language:
Java


Description: 
Improve the quality of shenyu doc of Document / Plugin Center part in 
https://shenyu.apache.org, so that everyone can easilly know and use plugin.
We have defined the template for new plugin and also have two examples 
ContextPath Plugin and Divide Plugin. And you can also refer current doc and 
rewrite base on it.
Details can refer to issue 
https://github.com/apache/incubator-shenyu-website/issues/471.


Output Requirements:
Rewrite the shenyu doc of Document / Plugin Center part match below 
requirements:
1. Use the newest code repository to write new plugin document and finish both 
Chinese and English versions.
2. New plugin document should follow the new template defined in issue 471.
3. New plugin document should be correct, unambiguous. Each config item should 
be explained with letter or picture(prefered) after read code or test in an 
example.
4. Everyone can easilly konw and use plugins by following the new plugin doc.


Technical Requirements:
Our main laguage is Java, so java and spring is a basic.
Also you need to have a good understanding of Apache shenyu's usage、code and 
principle.
For specific plugin you may need to pick up the knowledge of dubbo, grpc, 
motan, sofa, spring cloud, tars, websocket, hystric, ratelimiter, resilience4j, 
sentinel, jwt, oauth2, sign, waf, rocketmq and so on.


Project Repository: 
https://github.com/apache/incubator-shenyu-website.


Thanks,
AhahaGe





At 2022-04-01 10:37:46, "Kevin" <[email protected]> wrote:
>Dear Community Developer
>At yesterday's meeting, we confirmed that shenyu would participate in this
>summer activity[1].
>
>Combining the work that the community needs to do recently, I think the
>following two ideas may be proposed.
>
>The first is to complete the plugin documentation for the community and
>improve the quality of the existing documentation [2].
>Here is an example of the previous activity:
>1. Help the community improve the Quickstar guide document[3]
>2. Improve the quality of project documentation [4]
>
>Applying for this proposal requires some knowledge of Java and Spring. The
>idea can be defined as a mid-level or low-level project.
>
>
>The second is about refactoring the shenyu frontend. It can be a part of
>the refactoring, or the entire front end can be refactored.
>Here is an example of the previous activity:
>1. Casbin official core forum (front-end React + Javascript, back-end
>Golang) [5]
>The idea can be designated as an advanced or intermediate project.
>
>Applying for this proposal requires some knowledge of React or Vue.
>
>
>
>[1]: https://summer-ospp.ac.cn/#/homepage
>[2]:https://github.com/apache/incubator-shenyu-website/issues/471
>[3]:https://summer-ospp.ac.cn/2021/#/org/orgdetail/eventmesh/proid210650426
>[4]:
>https://summer-ospp.ac.cn/2021/#/org/orgdetail/apacheapisix/proid210050255
>[5]:https://summer-ospp.ac.cn/2021/#/org/orgdetail/casbin/proid210210453

Reply via email to