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 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