yu199195 opened a new issue, #675:
URL: https://github.com/apache/shenyu-website/issues/675

   
   ## Description
   
   Adding  documentation for quick start with websocket protocol for shenyu
   
   ## Task 
   
   1.  Add  english file :  quick-start-websocket.md  ,  under the 
https://github.com/apache/shenyu-website/tree/main/docs/quick-start
   2. Add  zh file :  quick-start-websocket.md  ,  under the 
https://github.com/apache/shenyu-website/tree/main/i18n/zh/docusaurus-plugin-content-docs/current/quick-start
   
   
   ## How to do this 
   1. Java development, and familiar with spring boot.
   2. You can see this :  
https://shenyu.apache.org/zh/docs/next/deployment/deployment-local , Complete 
your local environment.
   3. Run  shenyu/shenyu-examples/websocket
   4. See websocket plugin doc : 
https://shenyu.apache.org/zh/docs/next/plugin-center/proxy/websocket-plugin
   5.  Debugging  WebSocketPlugin.java  in your local.
   6. Summarize the quick-start-websocket.md , including how to start, source 
code analysis, etc.
   7.  Pull Request to shenyu website : https://github.com/apache/shenyu-websit
   
   
   ## How to contributor
   
   You can see this : [Contributor 
Guide](https://shenyu.apache.org/zh/community/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 [email protected]
   
   
   ## Verification
   
   After you modify file ,You verify local and you can see this : [Hao to build 
 shenyu website](https://github.com/apache/shenyu-website/blob/main/README.md) .
   
   After you pull request merged. You can verify to this :  
[en-doc](https://shenyu.apache.org/docs/next/quick-start/quick-start-websocket) 
,  
[zh-doc](https://shenyu.apache.org/zh/docs/next/quick-start/quick-start-websocket)
   
   
   After you pull request merged. You can verify to this : 
https://shenyu.apache.org/zh/docs/next/quick-start/quick-start-websocket
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to