From 46fb51395426c91e8184151e35a9ac6f1b85a1cb Mon Sep 17 00:00:00 2001 From: Phil Renaud Date: Tue, 16 Aug 2022 22:01:13 -0400 Subject: [PATCH] Keynav docs (#14148) * Section added to the API Docs UI page * Added a note about disabling * Prev and Next order --- website/content/api-docs/ui.mdx | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/website/content/api-docs/ui.mdx b/website/content/api-docs/ui.mdx index 675ffd49114d..a643e1992ada 100644 --- a/website/content/api-docs/ui.mdx +++ b/website/content/api-docs/ui.mdx @@ -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. +