Skip to content

Commit 2f20df2

Browse files
authored
Merge pull request #430 from layer5io/leecalcote/comments
Improve documentation for Kanvas Designer: update mouse mode hotkeys and add visual example for comments
2 parents 3a9e101 + ec4caad commit 2f20df2

File tree

5 files changed

+16
-8
lines changed

5 files changed

+16
-8
lines changed

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

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ aliases:
1313

1414
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 comments for reference later.
1515

16+
<figure>
17+
<img src="./kanvas-comment.png" alt="Comments in Designer" width="600">
18+
<figcaption>Example of comments in Designer</figcaption>
19+
</figure>
20+
1621
## Three Ways to Add Comments
1722

1823
You can add comments in three convenient ways:
@@ -21,18 +26,21 @@ You can add comments in three convenient ways:
2126

2227
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 canvas.
2328

24-
<img src="./Toolbar1.png" alt="Comment through toolbar (1)" width="600"/>
25-
29+
<img src="./comment-dock.png" alt="Create a comment from the dock" width="600"/>
2630

2731
### Commenting via Context-Click in Canvas
2832

29-
Right-click on any area of your canvas, and from the contextual menu, select "Comment" or use the shortcut ***Ctrl + M (Command + M for Mac users)***. This allows for swift comment placement right where you need it.
33+
Context-click on any area of your canvas, and from the contextual menu, select "Add a Comment". Using this context-click method allows for inline placement of your remarks right where you need them - in context.
3034

31-
<img src="./Right-click.png" alt="Comment by right-clicking" width="600" style="margin-bottom: 25px;">
35+
<img src="./comment-canvas.png" alt="Comment by context-clicking on canvas" width="600" style="margin-bottom: 25px;">
3236

3337
### Commenting via drag-and-drop from the Dock
3438

35-
To access comment from whiteboarding doc make sure your whiteboarding feature is enabled, select comment tool from doc and drop it anywhere on canvas to comment.
39+
To access comment from whiteboarding doc make sure your whiteboarding feature is enabled, select comment tool from doc and drop it anywhere on canvas to comment.
40+
41+
### Commenting via Hotkey
42+
43+
<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, you can move the new comment anywhere on the canvas.
3644

3745
## Tips for using Comments as a Design Review Tool
3846

Loading
Loading
Loading

content/en/kanvas/designer/understanding-tool-modes/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ aliases:
1616

1717
You can switch between mouse modes using hotkeys or tool selection. Here are hotkeys that control your mode:
1818

19-
- <button class="kbc-button kbc-button-xs">Spacebar</button> : Temporarily enables the alternative mouse mode (default mode vs pan mode)
20-
- <button class="kbc-button kbc-button-xs">H</button> : Switches to pan mode (hand icon)
21-
- <button class="kbc-button kbc-button-xs">Escape / V</button> : Switches to default mode irrespective of which mode you are currently using.
19+
- <button class="kbc-button kbc-button-xs">Spacebar</button>: Temporarily enables the alternative mouse mode (default mode vs pan mode)
20+
- <button class="kbc-button kbc-button-xs">H</button>: Switches to pan mode (hand icon)
21+
- <button class="kbc-button kbc-button-xs">Escape / V</button>: Switches to default mode irrespective of which mode you are currently using.
2222

2323
## Interacting with Components
2424
### Default Mode (no tool selected)

0 commit comments

Comments
 (0)