From 81cd903de9e009c3f57e3ff2671cc0fdd5d39646 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Tue, 12 Jan 2016 15:15:54 +0100 Subject: Refactor GitHub importer documentation [ci skip] --- .../importing/github_importer/importer.png | Bin 39335 -> 0 bytes .../importing/github_importer/new_project_page.png | Bin 46276 -> 0 bytes .../img/import_projects_from_github_importer.png | Bin 0 -> 28033 bytes ...mport_projects_from_github_new_project_page.png | Bin 0 -> 17225 bytes .../importing/import_projects_from_github.md | 46 ++++++++++++++++----- 5 files changed, 36 insertions(+), 10 deletions(-) delete mode 100644 doc/workflow/importing/github_importer/importer.png delete mode 100644 doc/workflow/importing/github_importer/new_project_page.png create mode 100644 doc/workflow/importing/img/import_projects_from_github_importer.png create mode 100644 doc/workflow/importing/img/import_projects_from_github_new_project_page.png (limited to 'doc/workflow') diff --git a/doc/workflow/importing/github_importer/importer.png b/doc/workflow/importing/github_importer/importer.png deleted file mode 100644 index 57636717571..00000000000 Binary files a/doc/workflow/importing/github_importer/importer.png and /dev/null differ diff --git a/doc/workflow/importing/github_importer/new_project_page.png b/doc/workflow/importing/github_importer/new_project_page.png deleted file mode 100644 index 002f22d81d7..00000000000 Binary files a/doc/workflow/importing/github_importer/new_project_page.png and /dev/null differ diff --git a/doc/workflow/importing/img/import_projects_from_github_importer.png b/doc/workflow/importing/img/import_projects_from_github_importer.png new file mode 100644 index 00000000000..f744dc06f81 Binary files /dev/null and b/doc/workflow/importing/img/import_projects_from_github_importer.png differ diff --git a/doc/workflow/importing/img/import_projects_from_github_new_project_page.png b/doc/workflow/importing/img/import_projects_from_github_new_project_page.png new file mode 100644 index 00000000000..86be35acb37 Binary files /dev/null and b/doc/workflow/importing/img/import_projects_from_github_new_project_page.png differ diff --git a/doc/workflow/importing/import_projects_from_github.md b/doc/workflow/importing/import_projects_from_github.md index 2027a055c37..77fb7ea7cd6 100644 --- a/doc/workflow/importing/import_projects_from_github.md +++ b/doc/workflow/importing/import_projects_from_github.md @@ -1,20 +1,46 @@ # Import your project from GitHub to GitLab -It takes just a couple of steps to import your existing GitHub projects to GitLab. Keep in mind that it is possible only if -GitHub support is enabled on your GitLab instance. You can read more about GitHub support [here](http://doc.gitlab.com/ce/integration/github.html) +_**Note:** In order to enable the GitHub import setting, you should first +enable the [GitHub integration][gh-import] in your GitLab instance._ -If you want to import from a GitHub Enterprise instance, you need to use GitLab Enterprise; please see the [EE docs for the GitHub integration](http://doc.gitlab.com/ee/integration/github.html). +At its current state, GitHub importer can import: -* Sign in to GitLab.com and go to your dashboard. -* To get to the importer page, you need to go to the "New project" page. +- the repository description +- the git repository data +- the issues +- the pull requests +- the wiki pages -![New project page](github_importer/new_project_page.png) +The importer page is visible when you [create a new project][new-project]. +Click on the **GitHub** link and you will be redirected to GitHub for +permission to access your projects. After accepting, you'll be automatically +redirected to the importer. -* Click on the "Import project from GitHub" link and you will be redirected to GitHub for permission to access your projects. After accepting, you'll be automatically redirected to the importer. +![New project page on GitLab](img/import_projects_from_github_new_project_page.png) -![Importer page](github_importer/importer.png) +--- -* To import a project, you can simple click "Add". The importer will import your repository, issues, and pull requests. Once the importer is done, a new GitLab project will be created with your imported data. +While at the GitHub importer page, you can see the import statuses of your +GitHub projects. Those that are being imported will show a _started_ status, +those already imported will be green, whereas those that are not yet imported +have an **Import** button on the right side of the table. If you want, you can +import all your GitHub projects in one go by hitting **Import all projects** +in the upper left corner. + +![GitHub importer page](img/import_projects_from_github_importer.png) + +--- + +The importer will create any new namespaces if they don't exist or in the +case the namespace is taken, the project will be imported on the user's +namespace. ### Note -When you import your projects from GitHub, it is not possible to keep your labels, milestones, and cross-repository pull requests. We are working on improving this in the near future. + +When you import your projects from GitHub, it is not possible to keep your +labels, milestones, and cross-repository pull requests. We are working on +improving this in the near future. + +[gh-import]: ../../integration/github.md "GitHub integration" +[ee-gh]: http://doc.gitlab.com/ee/integration/github.html "GitHub integration for GitLab EE" +[new-project]: ../../gitlab-basics/create-project.md "How to create a new project in GitLab" -- cgit v1.2.1 From 3fbd2b696440d3c421fc4477141615ce354d14cd Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Fri, 15 Jan 2016 23:40:11 +0100 Subject: Add the version each feature was introduced and remove note --- doc/workflow/importing/import_projects_from_github.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) (limited to 'doc/workflow') diff --git a/doc/workflow/importing/import_projects_from_github.md b/doc/workflow/importing/import_projects_from_github.md index 77fb7ea7cd6..694521ff490 100644 --- a/doc/workflow/importing/import_projects_from_github.md +++ b/doc/workflow/importing/import_projects_from_github.md @@ -5,11 +5,14 @@ enable the [GitHub integration][gh-import] in your GitLab instance._ At its current state, GitHub importer can import: -- the repository description -- the git repository data -- the issues -- the pull requests -- the wiki pages +- the repository description (introduced in GitLab 7.7) +- the git repository data (introduced in GitLab 7.7) +- the issues (introduced in GitLab 7.7) +- the pull requests (introduced in GitLab 8.4) +- the wiki pages (introduced in GitLab 8.4) + +It is not yet possible to import your labels and milestones. We are working on +improving this in the near future. The importer page is visible when you [create a new project][new-project]. Click on the **GitHub** link and you will be redirected to GitHub for @@ -35,12 +38,6 @@ The importer will create any new namespaces if they don't exist or in the case the namespace is taken, the project will be imported on the user's namespace. -### Note - -When you import your projects from GitHub, it is not possible to keep your -labels, milestones, and cross-repository pull requests. We are working on -improving this in the near future. - [gh-import]: ../../integration/github.md "GitHub integration" [ee-gh]: http://doc.gitlab.com/ee/integration/github.html "GitHub integration for GitLab EE" [new-project]: ../../gitlab-basics/create-project.md "How to create a new project in GitLab" -- cgit v1.2.1 From ed969aabddef5fd5911f3704f1843092025b98ec Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Sat, 16 Jan 2016 10:55:44 +0100 Subject: Importing GitHub cross-repository PRs is not supported atm [ci skip] --- doc/workflow/importing/import_projects_from_github.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'doc/workflow') diff --git a/doc/workflow/importing/import_projects_from_github.md b/doc/workflow/importing/import_projects_from_github.md index 694521ff490..f693f430a42 100644 --- a/doc/workflow/importing/import_projects_from_github.md +++ b/doc/workflow/importing/import_projects_from_github.md @@ -11,8 +11,9 @@ At its current state, GitHub importer can import: - the pull requests (introduced in GitLab 8.4) - the wiki pages (introduced in GitLab 8.4) -It is not yet possible to import your labels and milestones. We are working on -improving this in the near future. +It is not yet possible to import your labels, milestones and cross-repository +pull requests (those from forks). We are working on improving this in the near +future. The importer page is visible when you [create a new project][new-project]. Click on the **GitHub** link and you will be redirected to GitHub for -- cgit v1.2.1 From 1c728ddbce1b3e459e9c9332cf8753699955db43 Mon Sep 17 00:00:00 2001 From: John Galt Date: Tue, 19 Jan 2016 16:07:46 +0000 Subject: Fixed typo --- doc/workflow/protected_branches.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/workflow') diff --git a/doc/workflow/protected_branches.md b/doc/workflow/protected_branches.md index 0adf9f8e3e8..fdf9a8d391c 100644 --- a/doc/workflow/protected_branches.md +++ b/doc/workflow/protected_branches.md @@ -1,6 +1,6 @@ # Protected branches -Permission in GitLab are fundamentally defined around the idea of having read or write permission to the repository and branches. +Permissions in GitLab are fundamentally defined around the idea of having read or write permission to the repository and branches. To prevent people from messing with history or pushing code without review, we've created protected branches. -- cgit v1.2.1 From 465e4616c980367a7e075ef7f795879810d9b1e2 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Thu, 21 Jan 2016 22:32:55 +0100 Subject: Add file finder documentation [ci skip] --- doc/workflow/README.md | 1 + doc/workflow/file_finder.md | 42 +++++++++++++++++++++++++++ doc/workflow/img/file_finder_find_button.png | Bin 0 -> 30974 bytes doc/workflow/img/file_finder_find_file.png | Bin 0 -> 42658 bytes 4 files changed, 43 insertions(+) create mode 100644 doc/workflow/file_finder.md create mode 100644 doc/workflow/img/file_finder_find_button.png create mode 100644 doc/workflow/img/file_finder_find_file.png (limited to 'doc/workflow') 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. + +![Find file button](img/file_finder_find_button.png) + +--- + +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. + +![Find file button](img/file_finder_find_file.png) + +[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 new file mode 100644 index 00000000000..c5005d0d7ca Binary files /dev/null and b/doc/workflow/img/file_finder_find_button.png differ diff --git a/doc/workflow/img/file_finder_find_file.png b/doc/workflow/img/file_finder_find_file.png new file mode 100644 index 00000000000..58500f4c163 Binary files /dev/null and b/doc/workflow/img/file_finder_find_file.png differ -- cgit v1.2.1