Skip to content

Commit 9a6a93d

Browse files
committed
Refactor Kanvas documentation: remove outdated sharing resource section and enhance commenting instructions
Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
1 parent 35021c8 commit 9a6a93d

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

content/en/kanvas/designer/comments/index.md

+3-8
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ aliases:
1010
- /meshmap/designer/comments
1111
---
1212

13-
## Overview
14-
1513
Kanvas's Designer offers enables you to place comments "inline" with your infrastructure as code. Use comments to offer feedback to team members, take detailed design notes, capture helpful tips for your team members, and include justification as to your infrastructure and application configuration decisions. Pay it forward to your future self by leaving historical record for reference later.
1614

1715
<figure style="width:400px;">
@@ -21,11 +19,12 @@ Kanvas's Designer offers enables you to place comments "inline" with your infras
2119

2220
## Commenting on a Design
2321

24-
You can add comments in a number of convenient ways.
22+
You can add comments in a number of convenient ways. Since designs are public by default, you can add comments to your designs without having to share them first. This is particularly useful for gathering feedback from team members or stakeholders before finalizing the design.
2523

2624
### Commenting via the Dock
2725

28-
Click on the comment icon in the toolbar to open a comment instantly. This is your go-to method for quick annotations without leaving your design.
26+
1. Click on the comment icon in the toolbar to open a comment instantly. This is your go-to method for quick annotations without leaving your design or first identifying where you want to place your comment.
27+
2. You can also create a comment by dragging and dropping the comment icon from the Dock to your design. This method allows you to place comments directly on specific elements or areas of your design.
2928

3029
<figure style="width:400px;">
3130
<img src="./comment-dock.png" alt="Create a comment from the Dock" />
@@ -41,10 +40,6 @@ Context-click on any area of your design, and from the contextual menu, select "
4140
<figcaption>Comment by context-clicking on your design</figcaption>
4241
</figure>
4342

44-
### Commenting via drag-and-drop from the Dock
45-
46-
Add comments to your design by clicking and dragging a new comment from your dock to any area of your design. If you don't see a dock, ensure that the dock feature is enabled. To toggle visibility of the dock, context-click anywhere on the canvas, choose Options and enable the Dock feature.
47-
4843
### Commenting via hotkey
4944

5045
<button class="kbc-button kbc-button-xs">⌘/CTL + M</button> Add a comment into your design when you press this hotkey combination. After pressing the hotkey, a new comment will be displayed. You can move the new comment anywhere in your design.

content/en/kanvas/designer/share-resource/index.md renamed to content/en/kanvas/designer/sharing/index.md

+3
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,17 @@ categories: [Designer]
77
tags: [designs, collaboration, review]
88
aliases:
99
- /meshmap/designer/share-resource
10+
- /kanvas/designer/share-resource
1011
---
1112

1213
## Overview
1314

1415
In Kanvas, you can share your designs or designs for which you have permission to share with other members of your organization and teams, and you can control access permissions. This page describes the different access types for designs and how to effectively use them.
1516

1617
{{< alert title="Note">}}
18+
1719
- You can share and use control access to manage views permissions and visibility also with same methods.
20+
1821
{{< /alert >}}
1922

2023
## Visibility

0 commit comments

Comments
 (0)