Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Keynav docs #14148

Merged
merged 3 commits into from
Aug 17, 2022
Merged

Keynav docs #14148

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27e9822
Section added to the API Docs UI page
philrenaud Aug 16, 2022
8dadbb1
Added a note about disabling
philrenaud Aug 16, 2022
c06bd89
Prev and Next order
philrenaud Aug 16, 2022
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
31 changes: 31 additions & 0 deletions website/content/api-docs/ui.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,3 +553,34 @@ authenticate all future requests to allow read access to additional resources.
| Path | Produces |
| --------------------- | ----------- |
| `/ui/settings/tokens` | `text/html` |


## Keyboard Shortcuts

The Nomad UI supports several keyboard shortcuts in order to help users navigate and operate Nomad. You can use common key commands to dig into jobs, view logs, monitor evaluations, and more.

Type `?` from anywhere in the UI to launch the Keyboard Shortcuts panel.

### Default key commands:

| Command | Pattern |
| --------------------- | ----------- |
| Go to Jobs | `g j` |
| Go to Storage | `g r` |
| Go to Servers | `g s` |
| Go to Clients | `g c` |
| Go to Topology | `g t` |
| Go to Evaluations | `g e` |
| Go to ACL Tokens | `g a` |
| Next Subnav | `Shift + →` |
| Previous Subnav | `Shift + ←` |
| Next Main Section | `Shift + ↓` |
| Previous Main Section | `Shift + ↑` |
| Show Keyboard Shortcuts | `Shift + ?` |
| Hide Keyboard Shortcuts | `Escape` |
| Go Up a Level | `u` |

### Rebinding and Disabling Commands

From the Keyboard Shortcuts modal, you can click on any pattern to re-bind it to the shortcut of your choosing. This shortcut will persist via your browser's local storage and across refreshes. You can also toggle "Keyboard shortcuts enabled" to disable them completely.