Skip to content

Commit f40e454

Browse files
committed
update
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
1 parent a4f1f52 commit f40e454

1 file changed

Lines changed: 13 additions & 34 deletions

File tree

  • content/en/kanvas/designer/understanding-edges

content/en/kanvas/designer/understanding-edges/index.md

Lines changed: 13 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ When you connect components in [Kanvas](https://kanvas.new/), the line you draw
1616
In Kanvas, there are two main types of edges, each serving a different purpose:
1717

1818
### Semantic Edges
19+
1920
These edges represent real infrastructure relationships that Kanvas can understand and manage. For example:
2021
- Network connections between services
2122
- Volume mounts between containers
@@ -26,6 +27,7 @@ Kanvas uses these edges during deployment to understand how your components shou
2627
> For detailed information about each relationship type, visit [Relationships Documentation](https://docs.layer5.io/kanvas/concepts/relationships/)
2728
2829
### Non-semantic Edges
30+
2931
These are visual aids that help you document and explain your design. They are useful for:
3032
- Adding explanatory notes
3133
- Showing conceptual relationships
@@ -41,7 +43,7 @@ To help you quickly understand your diagrams, Kanvas uses specific default style
4143

4244
**Semantic Edges**
4345
- Style: Dotted line with an arrowhead
44-
- Color: Grey
46+
- Color: Grey/Blue
4547
- Use: For all real infrastructure connections
4648

4749
{{< meshery-design-embed src="../understanding-edges/images/embedded-design-untitled-design.js" id="embedded-design-d0a031d0-b4d7-4d60-be17-c4b5d2480ee6" size="half" >}}
@@ -57,46 +59,21 @@ To help you quickly understand your diagrams, Kanvas uses specific default style
5759

5860
While the default styles are designed to be clear and consistent, Kanvas gives you the flexibility to customize any edge to better suit your needs. Simply select an edge to reveal the styling toolbar.
5961

60-
#### Line Styles
61-
62-
**Primary Styles (Most Commonly Used)**
63-
64-
Straight Line
65-
- Default for most connections
66-
- Best for: Direct relationships and simple associations
67-
- Visual meaning: A clear, straightforward connection
68-
69-
Dotted Line
70-
- Default for semantic edges
71-
- Best for: Infrastructure connections (like network links, volume mounts)
72-
- Visual meaning: A system-managed connection
73-
74-
Bezier Curve
75-
- Best for: Non-linear or indirect connections
76-
- Visual meaning: A smooth, curved relationship between components
77-
78-
![Common line styles in Kanvas](images/line-styles.png)
79-
80-
**Additional Options**
81-
82-
These styles are available for specialized use cases:
83-
84-
Line Types
62+
#### Line Types
8563
- Dashed Line: For proposed or optional connections
8664
- Wave Line: For asynchronous or non-continuous connections
8765
- Zigzag Line: For disrupted or unreliable connections
8866
- Tree Line: For hierarchical relationships (parent-child, system-subsystem)
8967
- Line with Circles: For weak or indirect associations
68+
- Bezier Curve: For non-linear or indirect connections
9069

91-
Endpoint Styles
70+
#### Endpoint Types
9271
- Arrow Head (Default): Shows general direction or flow
9372
- Filled Diamond: For "whole-part" relationships (aggregation)
9473
- Filled Square: For strong ownership relationships (composition)
9574
- Filled Triangle: For inheritance or "is-a" relationships
9675
- Filled Circle: For loose containment relationships
9776

98-
![Advanced style examples](images/advanced-styles.png)
99-
10077
> **Note**: While Kanvas supports these UML-style relationships, the most commonly used styles are straight lines, dotted lines, and arrow heads. Use other styles when you need to express specific types of relationships in your diagrams.
10178
10279
#### Colors
@@ -105,14 +82,12 @@ Colors help you create a visual language in your diagrams. While Kanvas has defa
10582

10683
Default Colors
10784
- Green: For non-semantic annotations
108-
- Grey: For semantic relationships
85+
- Grey/Blue: For semantic relationships
10986

11087
Suggested Color Meanings
11188
- Yellow: For connections that need review
11289
- Red: For issues or breaking changes
11390

114-
![Color examples](images/color-examples.png)
115-
11691
### Labels and Annotations
11792

11893
You can add text directly to edges to provide more information. This is especially useful for:
@@ -124,6 +99,10 @@ You can add text directly to edges to provide more information. This is especial
12499
### Visual Effects
125100

126101
The "Marching-ants" animation effect can be added to any edge to:
127-
- Draw attention during presentations
128102
- Highlight specific connections in team reviews
129-
- Emphasize critical paths
103+
- Emphasize critical paths
104+
105+
106+
{{< alert title="Learn More About Interpreting Designs" type="info" >}}
107+
To learn how to interpret and understand designs in practice, including how components work together in a design, visit our comprehensive guide in the [Layer5 Academy](https://cloud.layer5.io/academy/learning-paths/mastering-meshery/introduction-to-meshery?chapter=interpreting-meshery-designs).
108+
{{< /alert >}}

0 commit comments

Comments
 (0)