]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-10609 add keyboard shortcuts documentation
authorStas Vilchik <stas.vilchik@sonarsource.com>
Tue, 15 May 2018 09:45:50 +0000 (11:45 +0200)
committerSonarTech <sonartech@sonarsource.com>
Thu, 17 May 2018 18:20:44 +0000 (20:20 +0200)
server/sonar-docs/src/EmbedDocsSuggestions.json
server/sonar-docs/src/pages/keyboard-shortcuts.md [new file with mode: 0644]

index 7455d98555c3dfc07b8780fbc00a13c50e1c4f01..91be7e4892e7a17ac40ee270498d97a9ecb82902 100644 (file)
@@ -7,18 +7,31 @@
     {
       "link": "/documentation/quality-profiles",
       "text": "Quality Profiles"
+    },
+    {
+      "link": "/documentation/keyboard-shortcuts",
+      "text": "Keyboard Shortcuts"
     }
   ],
   "component_measures": [
     {
       "link": "/documentation/fixing-the-water-leak",
       "text": "Fixing the Water Leak"
+    },
+    {
+      "link": "/documentation/keyboard-shortcuts",
+      "text": "Keyboard Shortcuts"
     }
   ],
   "custom_measures": [],
   "custom_metrics": [],
   "global_permissions": [],
-  "issues": [],
+  "issues": [
+    {
+      "link": "/documentation/keyboard-shortcuts",
+      "text": "Keyboard Shortcuts"
+    }
+  ],
   "marketplace": [],
   "overview": [
     {
diff --git a/server/sonar-docs/src/pages/keyboard-shortcuts.md b/server/sonar-docs/src/pages/keyboard-shortcuts.md
new file mode 100644 (file)
index 0000000..3ec59ae
--- /dev/null
@@ -0,0 +1,44 @@
+---
+title: Keyboard Shortcuts
+---
+
+## Global
+
+| Shortcut | Action          |
+| -------- | --------------- |
+| `s`      | open search bar |
+| `?`      | open help       |
+
+## Issues Page
+
+| Shortcut         | Action                                        |
+| ---------------- | --------------------------------------------- |
+| `↑` `↓`          | navigate between issues                       |
+| `→`              | go from the list of issues to the source code |
+| `←`              | return back to the list                       |
+| `alt` + `↑` `↓`  | to navigate issue locations                   |
+| `alt` + `←` `→`  | to switch flows                               |
+| `f`              | do an issue transition                        |
+| `a`              | assign issue                                  |
+| `m`              | assign issue to the current user              |
+| `i`              | change severity of issue                      |
+| `c`              | comment issue                                 |
+| `ctrl` + `enter` | submit comment                                |
+| `t`              | change tags of issue                          |
+
+## Measures Page
+
+| Shortcut | Action                                        |
+| -------- | --------------------------------------------- |
+| `↑` `↓`  | select files                                  |
+| `→`      | open file                                     |
+| `←`      | return back to the list                       |
+| `j` `k`  | switch between files                          |
+
+## Rules Page
+
+| Shortcut | Action                                        |
+| -------- | --------------------------------------------- |
+| `↑` `↓`  | navigate between rules                        |
+| `→`      | go from the list of rules to the rule details |
+| `←`      | return back to the list                       |