diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-01-21 22:32:55 +0100 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-01-21 22:32:55 +0100 |
| commit | 465e4616c980367a7e075ef7f795879810d9b1e2 (patch) | |
| tree | 3ca40a5d64cff9d981ede80a0828e7ce7017d067 /doc/workflow | |
| parent | 3f7993b5ceb9c5ba616dffef39f9b535482d92c1 (diff) | |
| download | gitlab-ce-465e4616c980367a7e075ef7f795879810d9b1e2.tar.gz | |
Add file finder documentation
[ci skip]
Diffstat (limited to 'doc/workflow')
| -rw-r--r-- | doc/workflow/README.md | 1 | ||||
| -rw-r--r-- | doc/workflow/file_finder.md | 42 | ||||
| -rw-r--r-- | doc/workflow/img/file_finder_find_button.png | bin | 0 -> 30974 bytes | |||
| -rw-r--r-- | doc/workflow/img/file_finder_find_file.png | bin | 0 -> 42658 bytes |
4 files changed, 43 insertions, 0 deletions
diff --git a/doc/workflow/README.md b/doc/workflow/README.md index 3651b55f438..bf62ab41053 100644 --- a/doc/workflow/README.md +++ b/doc/workflow/README.md @@ -6,6 +6,7 @@ - [GitLab Flow](gitlab_flow.md) - [Groups](groups.md) - [Keyboard shortcuts](shortcuts.md) +- [File finder](file_finder.md) - [Labels](labels.md) - [Notification emails](notifications.md) - [Project Features](project_features.md) diff --git a/doc/workflow/file_finder.md b/doc/workflow/file_finder.md new file mode 100644 index 00000000000..52ac5f032a5 --- /dev/null +++ b/doc/workflow/file_finder.md @@ -0,0 +1,42 @@ +# File finder + +_**Note:** This feature was [introduced][gh-9889] in GitLab 8.4._ + +--- + +The file finder feature allows you to quickly shortcut your way when you are +searching for a file in a repository using the GitLab UI. + +You can find the **Find File** button when in the **Files** section of a +project. + + + +--- + +For the more lazy, there is a [shortcut button](shortcuts.md) as well. + +Go the **Files** section of a project and press `t` on your keyboard to launch +the search function. Start typing what you are searching for and watch the +magic being unfold. With the up/down arrows, you go up and down the results, +with `Esc` you close the search and go back to **Files**. + +## How it works + +The File finder feature is powered by the [Fuzzy filter] library. + +It implements a fuzzy search with highlight, and tries to provide intuitive +results by recognizing patterns that people use while searching. + +For example, consider the [GitLab CE repository][ce] and that we want to open +the `app/controllers/admin/deploy_keys_controller.rb` file. + +Using fuzzy search, we start by typing letters that get us closer to the file. + +**Protip:** To narrow down your search, include `/` in your search terms. + + + +[gh-9889]: https://github.com/gitlabhq/gitlabhq/pull/9889 "File finder pull request" +[fuzzy filter]: https://github.com/jeancroy/fuzzaldrin-plus "fuzzaldrin-plus on GitHub" +[ce]: https://gitlab.com/gitlab-org/gitlab-ce/tree/master "GitLab CE repository" diff --git a/doc/workflow/img/file_finder_find_button.png b/doc/workflow/img/file_finder_find_button.png Binary files differnew file mode 100644 index 00000000000..c5005d0d7ca --- /dev/null +++ b/doc/workflow/img/file_finder_find_button.png diff --git a/doc/workflow/img/file_finder_find_file.png b/doc/workflow/img/file_finder_find_file.png Binary files differnew file mode 100644 index 00000000000..58500f4c163 --- /dev/null +++ b/doc/workflow/img/file_finder_find_file.png |
