Skip to content

Improve documentation for Kanvas Designer: update mouse mode hotkeys and add visual example for comments #430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions content/en/kanvas/designer/comments/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ aliases:

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.

<figure>
<img src="./kanvas-comment.png" alt="Comments in Designer" width="600">
<figcaption>Example of comments in Designer</figcaption>
</figure>

## Three Ways to Add Comments

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

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.

<img src="./Toolbar1.png" alt="Comment through toolbar (1)" width="600"/>

<img src="./comment-dock.png" alt="Create a comment from the dock" width="600"/>

### Commenting via Context-Click in Canvas

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.
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.

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

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

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.
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.

### Commenting via Hotkey

<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.

## Tips for using Comments as a Design Review Tool

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions content/en/kanvas/designer/understanding-tool-modes/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ aliases:

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

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

## Interacting with Components
### Default Mode (no tool selected)
Expand Down