meshery/meshery

[Docs] Add Kanvas testing instructions to Contributing to Model Relationships guide

Open

#18.021 aberto em 17 de mar. de 2026

Ver no GitHub
 (14 comments) (0 reactions) (1 assignee)HTML (10.013 stars) (3.101 forks)batch import
area/docsframework/hugohelp wantedlanguage/markdown

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:

  1. Run make ui-server from meshery root OR use playground.meshery.io
  2. Drag both components onto canvas
  3. Hover over a component to reveal connection arrows
  4. Manually draw edge to the target component
  5. Attach screenshot to PR description as proof

Guia do colaborador

Pilha de tecnologia
javascriptreactnodejshtml
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
blocked
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Basic knowledge of MesheryFamiliarity with Kanvas UILocal Meshery setup or playground access
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85
Direção de pesquisa
Review the existing Contributing to Model Relationships guide at https://docs.meshery.io/project/contributing/contributing relationships. Understand the current structure and identify where to insert the new 'Testing Your Relationship in Kanvas' section. Follow the steps outlined in the issue to ensure accuracy. Check comments for any additional context or maintainer guidance.