meshery/meshery
Ver no GitHub[Docs] Add Kanvas testing instructions to Contributing to Model Relationships guide
Open
#18.021 aberto em 17 de mar. de 2026
area/docsframework/hugohelp wantedlanguage/markdown
Métricas do repositório
- Stars
- (10.013 stars)
- Métricas de merge de PR
- (Mesclagem média 22d 16h) (332 fundiu PRs em 30d)
Description
Problem
The Contributing to Model Relationships guide currently covers how to create relationship definition JSON files, but lacks any instructions on how to visually test relationships before submitting a PR.
Contributors have no guidance on:
- How to run Meshery locally to load their relationship files
- How to drag components onto Meshery UI canvas
- How to hover over components to reveal connection arrows
- How to manually draw edges between components
- That edges do NOT appear automatically
- How to use playground.meshery.io as an alternative when local setup is unavailable
Impact
Without testing guidance, contributors submit PRs without visual proof, leading to back-and-forth review cycles. Reviewers then have to ask for Meshery UI screenshots separately.
Proposed Solution
Add a "Testing Your Relationship in Meshery UI" section to: https://docs.meshery.io/project/contributing/contributing-relationships
Steps to document:
- Run
make ui-serverfrom meshery root OR use playground.meshery.io - Drag both components onto canvas
- Hover over a component to reveal connection arrows
- Manually draw edge to the target component
- Attach screenshot to PR description as proof