diff options
author | Marcel Amirault <mamirault@gitlab.com> | 2019-09-06 20:43:20 +0000 |
---|---|---|
committer | Paul Slaughter <pslaughter@gitlab.com> | 2019-09-06 20:43:20 +0000 |
commit | 4361c89130fc2350be6ff79aaaf4bb3a55f83022 (patch) | |
tree | f854cd1978f9f2e046eb10a25b640daf8feec7da /doc/workflow | |
parent | 14fe47cec7a82299b88fd9b7e61e99c1a90bbc17 (diff) | |
download | gitlab-ce-4361c89130fc2350be6ff79aaaf4bb3a55f83022.tar.gz |
Update keyboard shortcuts modal and doc
Add missing shortcuts, remove shortcuts that don't exist,
and reorder as needed
Diffstat (limited to 'doc/workflow')
-rw-r--r-- | doc/workflow/shortcuts.md | 191 |
1 files changed, 108 insertions, 83 deletions
diff --git a/doc/workflow/shortcuts.md b/doc/workflow/shortcuts.md index 5d08bf5e77d..2ec733182f8 100644 --- a/doc/workflow/shortcuts.md +++ b/doc/workflow/shortcuts.md @@ -1,109 +1,134 @@ +--- +type: reference +--- + # GitLab keyboard shortcuts -You can see GitLab's keyboard shortcuts by using <kbd>shift</kbd> + <kbd>?</kbd> +GitLab has many useful keyboard shortcuts to make it easier to access different features. +You can see the quick reference sheet within GitLab itself with <kbd>Shift</kbd> + <kbd>?</kbd>. -## Global Shortcuts +The [Global Shortcuts](#global-shortcuts) work from any area of GitLab, but you must +be in specific pages for the other shortcuts to be available, as explained in each +section below. -| Keyboard Shortcut | Description | -| ----------------- | ----------- | -| <kbd>n</kbd> | Main navigation | -| <kbd>s</kbd> | Focus search | -| <kbd>f</kbd> | Focus filter | -| <kbd>p</kbd> + <kbd>b</kbd> | Show/hide the Performance Bar | -| <kbd>?</kbd> | Show/hide this dialog | -| <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>p</kbd> | Toggle markdown preview | -| <kbd>↑</kbd> | Edit last comment (when focused on an empty textarea) | +## Global Shortcuts -## Project Files Browsing +These shortcuts are available in most areas of GitLab + +| Keyboard Shortcut | Description | +| ------------------------------- | ----------- | +| <kbd>?</kbd> | Show/hide shortcut reference sheet. | +| <kbd>Shift</kbd> + <kbd>p</kbd> | Go to your Projects page. | +| <kbd>Shift</kbd> + <kbd>g</kbd> | Go to your Groups page. | +| <kbd>Shift</kbd> + <kbd>a</kbd> | Go to your Activity page. | +| <kbd>Shift</kbd> + <kbd>l</kbd> | Go to your Milestones page. | +| <kbd>Shift</kbd> + <kbd>s</kbd> | Go to your Snippets page. | +| <kbd>s</kbd> | Put cursor in the issues/merge requests search. | +| <kbd>Shift</kbd> + <kbd>i</kbd> | Go to your Issues page. | +| <kbd>Shift</kbd> + <kbd>m</kbd> | Go to your Merge requests page.| +| <kbd>Shift</kbd> + <kbd>t</kbd> | Go to your To-Do List page. | +| <kbd>p</kbd> + <kbd>b</kbd> | Show/hide the Performance Bar. | + +Additionally, the following shortcuts are available when editing text in text fields, +for example comments, replies, or issue and merge request descriptions: + +| Keyboard Shortcut | Description | +| ---------------------------------------------------------------------- | ----------- | +| <kbd>↑</kbd> | Edit your last comment. You must be in a blank text field below a thread, and you must already have at least one comment in the thread. | +| <kbd>⌘</kbd> (Mac) / <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>p</kbd> | Toggle Markdown preview, when editing text in a text field that has **Write** and **Preview** tabs at the top. | -| Keyboard Shortcut | Description | -| ----------------- | ----------- | -| <kbd>↑</kbd> | Move selection up | -| <kbd>↓</kbd> | Move selection down | -| <kbd>enter</kbd> | Open selection | +## Project -## Finding Project File +These shortcuts are available from any page within a project. You must type them +relatively quickly to work, and they will take you to another page in the project. + +| Keyboard Shortcut | Description | +| --------------------------- | ----------- | +| <kbd>g</kbd> + <kbd>p</kbd> | Go to the project home page (**Project > Details**). | +| <kbd>g</kbd> + <kbd>v</kbd> | Go to the project activity feed (**Project > Activity**). | +| <kbd>g</kbd> + <kbd>r</kbd> | Go to the project releases list (**Project > Releases**). | +| <kbd>g</kbd> + <kbd>f</kbd> | Go to the [project files](#project-files) list (**Repository > Files**). | +| <kbd>t</kbd> | Go to the project file search page. (**Repository > Files**, click **Find Files**). | +| <kbd>g</kbd> + <kbd>c</kbd> | Go to the project commits list (**Repository > Commits**). | +| <kbd>g</kbd> + <kbd>n</kbd> | Go to the [repository graph](#repository-graph) page (**Repository > Graph**). | +| <kbd>g</kbd> + <kbd>d</kbd> | Go to repository charts (**Repository > Charts**). | +| <kbd>g</kbd> + <kbd>i</kbd> | Go to the project issues list (**Issues > List**). | +| <kbd>i</kbd> | Go to the New Issue page (**Issues**, click **New Issue** ). | +| <kbd>g</kbd> + <kbd>b</kbd> | Go to the project issue boards list (**Issues > Boards**). | +| <kbd>g</kbd> + <kbd>m</kbd> | Go to the project merge requests list (**Merge Requests**). | +| <kbd>g</kbd> + <kbd>j</kbd> | Go to the CI/CD jobs list (**CI/CD > Jobs**). | +| <kbd>g</kbd> + <kbd>l</kbd> | Go to the project metrics (**Operations > Metrics**). | +| <kbd>g</kbd> + <kbd>e</kbd> | Go to the project environments (**Operations > Environments**). | +| <kbd>g</kbd> + <kbd>k</kbd> | Go to the project Kubernetes cluster integration page (**Operations > Kubernetes**). Note that you must have at least [`maintainer` permissions](../user/permissions.md) to access this page. | +| <kbd>g</kbd> + <kbd>s</kbd> | Go to the project snippets list (**Snippets**). | +| <kbd>g</kbd> + <kbd>w</kbd> | Go to the project wiki (**Wiki**), if enabled. | + +### Issues and Merge Requests + +These shortcuts are available when viewing issues and merge requests. + +| Keyboard Shortcut | Description | +| ---------------------------- | ----------- | +| <kbd>e</kbd> | Edit description. | +| <kbd>a</kbd> | Change assignee. | +| <kbd>m</kbd> | Change milestone. | +| <kbd>l</kbd> | Change label. | +| <kbd>r</kbd> | Start writing a comment. If any text is selected, it will be quoted in the comment. Can't be used to reply within a thread. | +| <kbd>n</kbd> | Move to next unresolved discussion (Merge requests only). | +| <kbd>p</kbd> | Move to previous unresolved discussion (Merge requests only). | +| <kbd>]</kbd> or <kbd>j</kbd> | Move to next file (Merge requests only). | +| <kbd>[</kbd> or <kbd>k</kbd> | Move to previous file (Merge requests only). | + +### Project Files + +These shortcuts are available when browsing the files in a project (navigate to +**Repository** > **Files**): | Keyboard Shortcut | Description | | ----------------- | ----------- | -| <kbd>↑</kbd> | Move selection up | -| <kbd>↓</kbd> | Move selection down | -| <kbd>enter</kbd> | Open selection | -| <kbd>esc</kbd> | Go back | +| <kbd>↑</kbd> | Move selection up. | +| <kbd>↓</kbd> | Move selection down. | +| <kbd>enter</kbd> | Open selection. | +| <kbd>esc</kbd> | Go back to file list screen (only while searching for files, **Repository > Files** then click on **Find File**). | +| <kbd>y</kbd> | Go to file permalink (only while viewing a file). | -## Global Dashboard +### Web IDE -| Keyboard Shortcut | Description | -| ----------------- | ----------- | -| <kbd>Shift</kbd> + <kbd>a</kbd> | Go to the activity feed | -| <kbd>Shift</kbd> + <kbd>p</kbd> | Go to projects | -| <kbd>Shift</kbd> + <kbd>i</kbd> | Go to issues | -| <kbd>Shift</kbd> + <kbd>m</kbd> | Go to merge requests | -| <kbd>Shift</kbd> + <kbd>t</kbd> | Go to todos | +These shortcuts are available when editing a file with the [Web IDE](../user/project/web_ide/index.md): -## Project +| Keyboard Shortcut | Description | +| ------------------------------------------------------- | ----------- | +| <kbd>⌘</kbd> (Mac) / <kbd>Ctrl</kbd> + <kbd>p</kbd> | Search for, and then open another file for editing. | +| <kbd>⌘</kbd> (Mac) / <kbd>Ctrl</kbd> + <kbd>Enter</kbd> | Commit (when editing the commit message). | -| Keyboard Shortcut | Description | -| ----------------- | ----------- | -| <kbd>g</kbd> + <kbd>p</kbd> | Go to the project's home page | -| <kbd>g</kbd> + <kbd>v</kbd> | Go to the project's activity feed | -| <kbd>g</kbd> + <kbd>f</kbd> | Go to files | -| <kbd>g</kbd> + <kbd>c</kbd> | Go to commits | -| <kbd>g</kbd> + <kbd>j</kbd> | Go to jobs | -| <kbd>g</kbd> + <kbd>n</kbd> | Go to network graph | -| <kbd>g</kbd> + <kbd>d</kbd> | Go to repository charts | -| <kbd>g</kbd> + <kbd>i</kbd> | Go to issues | -| <kbd>g</kbd> + <kbd>b</kbd> | Go to issue boards | -| <kbd>g</kbd> + <kbd>m</kbd> | Go to merge requests | -| <kbd>g</kbd> + <kbd>e</kbd> | Go to environments | -| <kbd>g</kbd> + <kbd>k</kbd> | Go to kubernetes | -| <kbd>g</kbd> + <kbd>s</kbd> | Go to snippets | -| <kbd>g</kbd> + <kbd>w</kbd> | Go to wiki | -| <kbd>t</kbd> | Go to finding file | -| <kbd>i</kbd> | New issue | - -## Network Graph +### Repository Graph -| Keyboard Shortcut | Description | -| ----------------- | ----------- | -| <kbd>←</kbd> or <kbd>h</kbd> | Scroll left | -| <kbd>→</kbd> or <kbd>l</kbd> | Scroll right | -| <kbd>↑</kbd> or <kbd>k</kbd> | Scroll up | -| <kbd>↓</kbd> or <kbd>j</kbd> | Scroll down | -| <kbd>Shift</kbd> + <kbd>↑</kbd> or <kbd>Shift</kbd> + <kbd>k</kbd> | Scroll to top | -| <kbd>Shift</kbd> + <kbd>↓</kbd> or <kbd>Shift</kbd> + <kbd>j</kbd> | Scroll to bottom | +These shortcuts are available when viewing the project [repository graph](../user/project/repository/index.md#repository-graph) +page (navigate to **Repository > Graph**): -## Issues and Merge Requests +| Keyboard Shortcut | Description | +| ------------------------------------------------------------------ | ----------- | +| <kbd>←</kbd> or <kbd>h</kbd> | Scroll left. | +| <kbd>→</kbd> or <kbd>l</kbd> | Scroll right. | +| <kbd>↑</kbd> or <kbd>k</kbd> | Scroll up. | +| <kbd>↓</kbd> or <kbd>j</kbd> | Scroll down. | +| <kbd>Shift</kbd> + <kbd>↑</kbd> or <kbd>Shift</kbd> + <kbd>k</kbd> | Scroll to top. | +| <kbd>Shift</kbd> + <kbd>↓</kbd> or <kbd>Shift</kbd> + <kbd>j</kbd> | Scroll to bottom. | -| Keyboard Shortcut | Description | -| ----------------- | ----------- | -| <kbd>a</kbd> | Change assignee | -| <kbd>m</kbd> | Change milestone | -| <kbd>r</kbd> | Reply (quoting selected text) | -| <kbd>e</kbd> | Edit issue/merge request | -| <kbd>l</kbd> | Change label | -| <kbd>]</kbd> or <kbd>j</kbd> | Move to next file | -| <kbd>[</kbd> or <kbd>k</kbd> | Move to previous file | -| <kbd>n</kbd> | Move to next unresolved discussion | -| <kbd>p</kbd> | Move to previous unresolved discussion | +### Wiki pages -## Epics **(ULTIMATE)** +This shortcut is available when viewing a [wiki page](../user/project/wiki/index.md): | Keyboard Shortcut | Description | | ----------------- | ----------- | -| <kbd>r</kbd> | Reply (quoting selected text) | -| <kbd>e</kbd> | Edit description | -| <kbd>l</kbd> | Change label | - -## Wiki pages +| <kbd>e</kbd> | Edit wiki page. | -| Keyboard Shortcut | Description | -| ----------------- | ----------- | -| <kbd>e</kbd> | Edit wiki page| +## Epics **(ULTIMATE)** -## Web IDE +These shortcuts are available when viewing [Epics](../user/group/epics/index.md): | Keyboard Shortcut | Description | | ----------------- | ----------- | -| <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>p</kbd> | Go to file | -| <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>Enter</kbd> | Commit (when editing the commit message) | +| <kbd>r</kbd> | Start writing a comment. If any text is selected, it will be quoted in the comment. Can't be used to reply within a thread. | +| <kbd>e</kbd> | Edit description. | +| <kbd>l</kbd> | Change label. | |