kmesh-net/kmesh
Improve setup documentation with prerequisites and clearer installation flow
Offen
#1.642 geöffnet am 04.04.2026
good first issue
Repository-Metriken
- Stars
- (739 Sterne)
- PR-Merge-Metriken
- (Durchschn. Merge 6T 4h) (8 gemergte PRs in 30 T)
Beschreibung
Problem
While setting up Kmesh locally, I noticed that the current documentation can be confusing for new contributors, especially around the installation flow.
Some key challenges:
- Istio dependency is not clearly highlighted before deployment
- The correct setup order is not explicitly defined
- It is unclear how to verify a successful installation
- New users may attempt to run kmesh-daemon directly without a Kubernetes environment
Proposed Solution
I would like to improve the setup documentation by:
- Adding a "Prerequisites" section (including Istio requirement)
- Defining a clear setup flow (Kubernetes → Istio → Kmesh)
- Adding verification steps (e.g., checking running pods)
- Including a "Common Mistakes" section to avoid confusion
Motivation
As a new contributor, I faced these issues during setup. Improving the documentation would make onboarding easier for others and reduce setup friction.
Additional Context
I have successfully set up Kmesh locally and verified the deployment, so I can contribute these improvements based on real experience.
I would like to work on this issue. Please let me know if this approach looks good.