-
Notifications
You must be signed in to change notification settings - Fork 181
docs: network tips #208
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
docs: network tips #208
Conversation
Signed-off-by: JaredforReal <w13431838023@gmail.com>
✅ Deploy Preview for vllm-semantic-router ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
👥 vLLM Semantic Team NotificationThe following members have been identified for the changed files in this PR and have been automatically assigned: 📁
|
/hold i think the network issue shouldnt be documented separately in docs cc @rootfs thoughs on it? |
I used to write the network solution in code, and comment them with notes: "uncommented to ......", which made the PR too complicated, so I try writting a separate docs to keep code clean. |
@JaredforReal how about creating a top level triage and diagnostic section (please come up with a better name)? This will cover how to build, deploy, and maintain the router & models, benefiting SDE, MLE, and SRE. This networking tips you provided can be the first under this section. |
@rootfs Good idea! I could create and maintain an "Operation Handbook", which includes "Network Tips for CN Users" and "Observability and Monitoring" of the project I recently working on. This can be helpful for anyone not satisfied with just "getting started", by introducing some best practices or recommended actions. |
@JaredforReal sgtm, @Xunzhuo wdyt? |
I think let us not emphasize network issue in CN, it could be happening in anywhere else as well, my suggestion is to add an new section called troubleshooting and add this doc into it |
I can get rig of "CN Mainland" kind of word, and use CN-mirror as an example when necessary. |
That'll be much better! |
Cool I want to make sure it's as neutral as possible |
Signed-off-by: JaredforReal <w13431838023@gmail.com>
lgtm, @Xunzhuo can you share the final thought? thanks |
/lgtm thanks! |
Signed-off-by: JaredforReal <w13431838023@gmail.com>
Signed-off-by: liuhy <liuhongyu@apache.org>
What type of PR is this?
docs: network tips for CN Mainlain
What this PR does / why we need it:
This guide shows exactly how to build and run in CN Mainland, using small local override files and a compose override, without modifying repo files.
It would be helpful for people living in CN Mainland, annoyed by network blocking