diff options
author | Marcel Amirault <mamirault@gitlab.com> | 2019-08-08 16:54:29 +0900 |
---|---|---|
committer | Marcel Amirault <mamirault@gitlab.com> | 2019-08-08 16:54:29 +0900 |
commit | 5b270feaa3d1e0349f5974eae7ab04070debe64c (patch) | |
tree | 9e2330c8622a7d071e63a7fcc14e35f898be03b7 | |
parent | cfb4bc4248ae6e905ed2e81afcc44a077f27086e (diff) | |
download | gitlab-ce-docs-keyboard-shortcuts.tar.gz |
Second pass of keyboard shortcut refactordocs-keyboard-shortcuts
Reorder sections, and combine project files sections
together. Also rewords intro and fixed navigation bolding
-rw-r--r-- | doc/workflow/shortcuts.md | 89 |
1 files changed, 40 insertions, 49 deletions
diff --git a/doc/workflow/shortcuts.md b/doc/workflow/shortcuts.md index 2849d1269ca..a1b0e1f5acd 100644 --- a/doc/workflow/shortcuts.md +++ b/doc/workflow/shortcuts.md @@ -7,9 +7,9 @@ type: reference 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>. -In general, you don't anything selected for these to work (unless otherwise noted), -but certain shortcuts are related to specific pages in GitLab, so you must be on that -page for them to work, as noted in each section below. +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. ## Global Shortcuts @@ -37,23 +37,39 @@ relatively quickly to work, and they will take you to another page in the projec | 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>f</kbd> | Go to the [project files](#project-files) list (**Repository** > **Files**). | -| <kbd>t</kbd> | Go to the [find project file](#find-project-files) 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>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>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>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>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>a</kbd> | Change assignee. | +| <kbd>m</kbd> | Change milestone. | +| <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. | +| <kbd>]</kbd> or <kbd>j</kbd> | Move to next file. | +| <kbd>[</kbd> or <kbd>k</kbd> | Move to previous file. | + ### Project Files These shortcuts are available when browsing the files in a project (navigate to @@ -64,23 +80,21 @@ These shortcuts are available when browsing the files in a project (navigate to | <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**) | -#### Find Project Files +### Web IDE -These shortcuts are available when searching for files (navigate to **Repository** > **Files** -then click on **Find File**): +These shortcuts are available when editing a file with the [Web IDE](../user/project/web_ide/index.md): | Keyboard Shortcut | Description | | ----------------- | ----------- | -| <kbd>↑</kbd> | Move selection up | -| <kbd>↓</kbd> | Move selection down | -| <kbd>enter</kbd> | Open selection | -| <kbd>esc</kbd> | Go back to file list screen | +| <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>p</kbd> | Search for, and then open another file for editing | +| <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>Enter</kbd> | Commit (when editing the commit message) | ### Repository Graph These shortcuts are available when viewing the project [repository graph](../user/project/repository/index.md#repository-graph) -page (navigate to **Repository** > **Graph**): +page (navigate to **Repository > Graph**): | Keyboard Shortcut | Description | | ----------------- | ----------- | @@ -91,19 +105,13 @@ page (navigate to **Repository** > **Graph**): | <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 | -### Issues and Merge Requests +### Wiki pages -These shortcuts are available when viewing issues and merge requests. +This shortcut is available when viewing a [wiki page](../user/project/wiki/index.md): | Keyboard Shortcut | Description | | ----------------- | ----------- | -| <kbd>a</kbd> | Change assignee. | -| <kbd>m</kbd> | Change milestone. | -| <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. | -| <kbd>]</kbd> or <kbd>j</kbd> | Move to next file. | -| <kbd>[</kbd> or <kbd>k</kbd> | Move to previous file. | +| <kbd>e</kbd> | Edit wiki page | ## Epics **(ULTIMATE)** @@ -114,20 +122,3 @@ These shortcuts are available when viewing [Epics](../user/group/epics/index.md) | <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 | - -## Wiki pages - -This shortcut is available when viewing a [wiki page](../user/project/wiki/index.md): - -| Keyboard Shortcut | Description | -| ----------------- | ----------- | -| <kbd>e</kbd> | Edit wiki page | - -## Web IDE - -These shortcuts are available when editing a file with the [Web IDE](../user/project/web_ide/index.md): - -| Keyboard Shortcut | Description | -| ----------------- | ----------- | -| <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>p</kbd> | Search for, and then open another file for editing | -| <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>Enter</kbd> | Commit (when editing the commit message) | |