Skip to content

Commit 45092c5

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

1 file changed

Lines changed: 20 additions & 21 deletions

File tree

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

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

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ categories: [Designer]
77
tags: [designs]
88
---
99

10-
When you connect components in [Kanvas](https://kanvas.new/), the line you draw is called an edge. Each edge visually represents a [relationship](https://docs.layer5.io/kanvas/concepts/relationships/) between your components. This guide will help you understand how to use different edge styles to create clear and effective infrastructure diagrams.
10+
When you connect components in [Kanvas](https://kanvas.new/), the line you draw is called an **edge**. Each edge visually represents a [relationship](https://docs.layer5.io/kanvas/concepts/relationships/) between your components. This guide explains how to use different edge styles to create clear and effective infrastructure designs.
1111

1212
![Examples of changing edge styles in Kanvas](images/style-edge.gif)
1313

14-
## Types of Edges
14+
## Understanding Edge Types
1515

1616
In Kanvas, there are two main types of edges, each serving a different purpose:
1717

18-
### Semantic Edges
18+
### Semantic Edges: Representing Real Infrastructure
1919

2020
These edges represent real infrastructure relationships that Kanvas can understand and manage. For example:
2121
- Network connections between services
@@ -26,7 +26,7 @@ Kanvas uses these edges during deployment to understand how your components shou
2626

2727
> For detailed information about each relationship type, visit [Relationships Documentation](https://docs.layer5.io/kanvas/concepts/relationships/)
2828
29-
### Non-semantic Edges
29+
### Non-semantic Edges: Annotating Your Designs
3030

3131
These are visual aids that help you document and explain your design. They are useful for:
3232
- Adding explanatory notes
@@ -35,20 +35,20 @@ These are visual aids that help you document and explain your design. They are u
3535

3636
Kanvas ignores these edges during deployment as they are purely for documentation.
3737

38-
## Edge Styles
38+
## Working with Edge Styles
3939

40-
### Default Edge Styles
40+
### Default Styles
4141

42-
To help you quickly understand your diagrams, Kanvas uses specific default styles for each type of edge:
42+
To help you quickly understand your designs, Kanvas uses specific default styles for each type of edge:
4343

44-
**Semantic Edges**
44+
**For Semantic Edges**:
4545
- Style: Dotted line with an arrowhead
4646
- Color: Grey/Blue
4747
- Use: For all real infrastructure connections
4848

4949
{{< meshery-design-embed src="../understanding-edges/images/embedded-design-untitled-design.js" id="embedded-design-d0a031d0-b4d7-4d60-be17-c4b5d2480ee6" size="half" >}}
5050

51-
**Non-semantic Edges**
51+
**For Non-semantic Edges**:
5252
- Style: Solid line with an arrowhead
5353
- Color: Green
5454
- Use: For all visual annotations and notes
@@ -57,52 +57,51 @@ To help you quickly understand your diagrams, Kanvas uses specific default style
5757

5858
### Customizing Edge Styles
5959

60-
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.
60+
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 click an edge to reveal the styling toolbar.
6161

62-
#### Line Types
62+
#### Choosing a Line Type
6363
- Dashed Line: For proposed or optional connections
6464
- Wave Line: For asynchronous or non-continuous connections
6565
- Zigzag Line: For disrupted or unreliable connections
6666
- Tree Line: For hierarchical relationships (parent-child, system-subsystem)
6767
- Line with Circles: For weak or indirect associations
6868
- Bezier Curve: For non-linear or indirect connections
6969

70-
#### Endpoint Types
70+
#### Defining Connection Points
7171
- Arrow Head (Default): Shows general direction or flow
7272
- Filled Diamond: For "whole-part" relationships (aggregation)
7373
- Filled Square: For strong ownership relationships (composition)
7474
- Filled Triangle: For inheritance or "is-a" relationships
7575
- Filled Circle: For loose containment relationships
7676

77-
> **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.
77+
> **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 designs.
7878
79-
#### Colors
79+
#### Using Color for Visual Cues
8080

81-
Colors help you create a visual language in your diagrams. While Kanvas has default colors, you can use any color to convey meaning:
81+
Colors help you create a visual language in your designs. While Kanvas has default colors, you can use any color to convey meaning:
8282

83-
Default Colors
83+
**Default Colors**
8484
- Green: For non-semantic annotations
8585
- Grey/Blue: For semantic relationships
8686

87-
Suggested Color Meanings
87+
**Suggested Color Meanings**
8888
- Yellow: For connections that need review
8989
- Red: For issues or breaking changes
9090

91-
### Labels and Annotations
91+
#### Adding Labels
9292

9393
You can add text directly to edges to provide more information. This is especially useful for:
9494
- Describing traffic flow (e.g., "User Traffic → API Gateway")
9595
- Adding process steps (e.g., "Requires Manual Review")
9696
- Noting important details (e.g., "Backup Route (Low Priority)")
9797
- Specifying protocols (e.g., "gRPC / 50051")
9898

99-
### Visual Effects
99+
#### Applying Visual Effects
100100

101101
The "Marching-ants" animation effect can be added to any edge to:
102102
- Highlight specific connections in team reviews
103103
- Emphasize critical paths
104104

105-
106105
{{< alert title="Learn More About Interpreting Designs" type="info" >}}
107106
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 >}}
107+
{{< /alert >}}

0 commit comments

Comments
 (0)