Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WeOpen-Star] Add Quick start with websocket #675

Closed
yu199195 opened this issue Aug 5, 2022 · 1 comment
Closed

[WeOpen-Star] Add Quick start with websocket #675

yu199195 opened this issue Aug 5, 2022 · 1 comment
Assignees
Labels
good first issue Good for newcomers

Comments

@yu199195
Copy link
Member

yu199195 commented Aug 5, 2022

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

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 : Hao 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

@lahmXu
Copy link
Member

lahmXu commented Aug 5, 2022

[WeOpen Star]I would like to help

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants