summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJob van der Voort <job@gitlab.com>2015-06-09 07:01:50 +0000
committerJob van der Voort <job@gitlab.com>2015-06-09 07:01:50 +0000
commitfbe1ca39aadcfacb038ba16b712579d6e7532b71 (patch)
treec6effaac82303d8cec1d54cc8416c445d2ac3920
parentb637f849503db06f38812184aec398f2e4e29d09 (diff)
parented42be4019f2640b1a66fff487c6581a0df3bffd (diff)
downloadgitlab-ce-fbe1ca39aadcfacb038ba16b712579d6e7532b71.tar.gz
Merge branch 'fixing_importing_doc' into 'master'
Fixing importing doc Fixed some details about the importing links and documents. - Added extra info to Bitbucket importing - Organized docs in alphabetical order - Moved Importing link to general documentation, instead of workflow (that's where Sytse asked me to add it) Thank you @job for merging previous changes. See merge request !1845
-rw-r--r--doc/README.md69
-rw-r--r--doc/workflow/README.md33
-rw-r--r--doc/workflow/import_projects_from_bitbucket.md49
-rw-r--r--doc/workflow/import_projects_from_github.md36
4 files changed, 95 insertions, 92 deletions
diff --git a/doc/README.md b/doc/README.md
index 4e00dceac2b..7a2181edded 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -1,34 +1,35 @@
-# Documentation
-
-## User documentation
-
-- [API](api/README.md) Automate GitLab via a simple and powerful API.
-- [Markdown](markdown/markdown.md) GitLab's advanced formatting system.
-- [Permissions](permissions/permissions.md) Learn what each role in a project (guest/reporter/developer/master/owner) can do.
-- [Project Services](project_services/project_services.md) Integrate a project with external services, such as CI and chat.
-- [Public access](public_access/public_access.md) Learn how you can allow public and internal access to projects.
-- [SSH](ssh/README.md) Setup your ssh keys and deploy keys for secure access to your projects.
-- [Web hooks](web_hooks/web_hooks.md) Let GitLab notify you when new code has been pushed to your project.
-- [Workflow](workflow/README.md) Using GitLab functionality and importing projects from GitHub and SVN.
-- [GitLab as OAuth2 authentication service provider](integration/oauth_provider.md). It allows you to login to other applications from GitLab.
-
-## Administrator documentation
-
-- [Install](install/README.md) Requirements, directory structures and installation from source.
-- [Integration](integration/README.md) How to integrate with systems such as JIRA, Redmine, LDAP and Twitter.
-- [Raketasks](raketasks/README.md) Backups, maintenance, automatic web hook setup and the importing of projects.
-- [Custom git hooks](hooks/custom_hooks.md) Custom git hooks (on the filesystem) for when web hooks aren't enough.
-- [System hooks](system_hooks/system_hooks.md) Notifications when users, projects and keys are changed.
-- [Security](security/README.md) Learn what you can do to further secure your GitLab instance.
-- [Update](update/README.md) Update guides to upgrade your installation.
-- [Welcome message](customization/welcome_message.md) Add a custom welcome message to the sign-in page.
-- [Issue closing](customization/issue_closing.md) Customize how to close an issue from commit messages.
-- [Libravatar](customization/libravatar.md) Use Libravatar for user avatars.
-- [Operations](operations/README.md) Keeping GitLab up and running
-- [Log system](logs/logs.md) Log system
-
-## Contributor documentation
-
-- [Development](development/README.md) Explains the architecture and the guidelines for shell commands.
-- [Legal](legal/README.md) Contributor license agreements.
-- [Release](release/README.md) How to make the monthly and security releases.
+# Documentation
+
+## User documentation
+
+- [API](api/README.md) Automate GitLab via a simple and powerful API.
+- [GitLab as OAuth2 authentication service provider](integration/oauth_provider.md). It allows you to login to other applications from GitLab.
+- [Importing to GitLab](workflow/importing/README.md).
+- [Markdown](markdown/markdown.md) GitLab's advanced formatting system.
+- [Permissions](permissions/permissions.md) Learn what each role in a project (guest/reporter/developer/master/owner) can do.
+- [Project Services](project_services/project_services.md) Integrate a project with external services, such as CI and chat.
+- [Public access](public_access/public_access.md) Learn how you can allow public and internal access to projects.
+- [SSH](ssh/README.md) Setup your ssh keys and deploy keys for secure access to your projects.
+- [Web hooks](web_hooks/web_hooks.md) Let GitLab notify you when new code has been pushed to your project.
+- [Workflow](workflow/README.md) Using GitLab functionality and importing projects from GitHub and SVN.
+
+## Administrator documentation
+
+- [Custom git hooks](hooks/custom_hooks.md) Custom git hooks (on the filesystem) for when web hooks aren't enough.
+- [Install](install/README.md) Requirements, directory structures and installation from source.
+- [Integration](integration/README.md) How to integrate with systems such as JIRA, Redmine, LDAP and Twitter.
+- [Issue closing](customization/issue_closing.md) Customize how to close an issue from commit messages.
+- [Libravatar](customization/libravatar.md) Use Libravatar for user avatars.
+- [Log system](logs/logs.md) Log system.
+- [Operations](operations/README.md) Keeping GitLab up and running
+- [Raketasks](raketasks/README.md) Backups, maintenance, automatic web hook setup and the importing of projects.
+- [Security](security/README.md) Learn what you can do to further secure your GitLab instance.
+- [System hooks](system_hooks/system_hooks.md) Notifications when users, projects and keys are changed.
+- [Update](update/README.md) Update guides to upgrade your installation.
+- [Welcome message](customization/welcome_message.md) Add a custom welcome message to the sign-in page.
+
+## Contributor documentation
+
+- [Development](development/README.md) Explains the architecture and the guidelines for shell commands.
+- [Legal](legal/README.md) Contributor license agreements.
+- [Release](release/README.md) How to make the monthly and security releases. \ No newline at end of file
diff --git a/doc/workflow/README.md b/doc/workflow/README.md
index 809b8d16abc..70a8179c8eb 100644
--- a/doc/workflow/README.md
+++ b/doc/workflow/README.md
@@ -1,17 +1,16 @@
-# Workflow
-
-- [Feature branch workflow](workflow.md)
-- [Project forking workflow](forking_workflow.md)
-- [Project Features](project_features.md)
-- [Authorization for merge requests](authorization_for_merge_requests.md)
-- [Groups](groups.md)
-- [Labels](labels.md)
-- [GitLab Flow](gitlab_flow.md)
-- [Notifications](notifications.md)
-- [Importing to GitLab](doc/importing/README.md)
-- [Two-factor Authentication (2FA)](two_factor_authentication.md)
-- [Protected branches](protected_branches.md)
-- [Change your time zone](timezone.md)
-- [Keyboard shortcuts](shortcuts.md)
-- [Web Editor](web_editor.md)
-- ["Work In Progress" Merge Requests](wip_merge_requests.md)
+# Workflow
+
+- [Authorization for merge requests](authorization_for_merge_requests.md)
+- [Change your time zone](timezone.md)
+- [Feature branch workflow](workflow.md)
+- [GitLab Flow](gitlab_flow.md)
+- [Groups](groups.md)
+- [Keyboard shortcuts](shortcuts.md)
+- [Labels](labels.md)
+- [Notifications](notifications.md)
+- [Project Features](project_features.md)
+- [Project forking workflow](forking_workflow.md)
+- [Protected branches](protected_branches.md)
+- [Two-factor Authentication (2FA)](two_factor_authentication.md)
+- [Web Editor](web_editor.md)
+- ["Work In Progress" Merge Requests](wip_merge_requests.md) \ No newline at end of file
diff --git a/doc/workflow/import_projects_from_bitbucket.md b/doc/workflow/import_projects_from_bitbucket.md
index 341b1a5f86c..20d65f1925a 100644
--- a/doc/workflow/import_projects_from_bitbucket.md
+++ b/doc/workflow/import_projects_from_bitbucket.md
@@ -1,23 +1,26 @@
-# Import your project from Bitbucket to GitLab
-
-It takes just a few steps to import your existing Bitbucket projects to GitLab. But keep in mind that it is possible only if Bitbucket support is enabled on your GitLab instance. You can read more about Bitbucket support [here](doc/integration/bitbucket.md).
-
-1. Sign in to GitLab.com and go to your dashboard
-
-2. Click on "New project"
-
-![New project in GitLab](bitbucket_importer/bitbucket_import_new_project.jpg)
-
-3. Click on the "Bitbucket" button
-
-![Bitbucket](bitbucket_importer/bitbucket_import_select_bitbucket.jpg)
-
-4. Grant GitLab access to your Bitbucket account
-
-![Grant access](bitbucket_importer/bitbucket_import_grant_access.jpg)
-
-5. Click on the projects that you'd like to import or "Import all projects"
-
-![Import projects](bitbucket_importer/bitbucket_import_select_project.png)
-
-A new GitLab project will be created with your imported data.
+# Import your project from Bitbucket to GitLab
+
+It takes just a few steps to import your existing Bitbucket projects to GitLab. But keep in mind that it is possible only if Bitbucket support is enabled on your GitLab instance. You can read more about Bitbucket support [here](doc/integration/bitbucket.md).
+
+* Sign in to GitLab.com and go to your dashboard
+
+* Click on "New project"
+
+![New project in GitLab](bitbucket_importer/bitbucket_import_new_project.jpg)
+
+* Click on the "Bitbucket" button
+
+![Bitbucket](bitbucket_importer/bitbucket_import_select_bitbucket.jpg)
+
+* Grant GitLab access to your Bitbucket account
+
+![Grant access](bitbucket_importer/bitbucket_import_grant_access.jpg)
+
+* Click on the projects that you'd like to import or "Import all projects"
+
+![Import projects](bitbucket_importer/bitbucket_import_select_project.png)
+
+A new GitLab project will be created with your imported data.
+
+### Note
+Milestones and wiki pages are not imported from Bitbucket. \ No newline at end of file
diff --git a/doc/workflow/import_projects_from_github.md b/doc/workflow/import_projects_from_github.md
index c04906034c0..aad2c63817d 100644
--- a/doc/workflow/import_projects_from_github.md
+++ b/doc/workflow/import_projects_from_github.md
@@ -1,18 +1,18 @@
-# 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)
-
-1. Sign in to GitLab.com and go to your dashboard.
-2. To get to the importer page, you need to go to the "New project" page.
-
-![New project page](github_importer/new_project_page.png)
-
-3. 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.
-
-![Importer page](github_importer/importer.png)
-
-4. To import a project, you can simple click "Add". The importer will import your repository and issues. Once the importer is done, a new GitLab project will be created with your imported data.
-
-### Note
-When you import your projects from GitHub, it is not possible to keep your labels and milestones and issue numbers won't match. We are working on improving this in the near future.
+# 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)
+
+* 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.
+
+![New project page](github_importer/new_project_page.png)
+
+* 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.
+
+![Importer page](github_importer/importer.png)
+
+* To import a project, you can simple click "Add". The importer will import your repository and issues. Once the importer is done, a new GitLab project will be created with your imported data.
+
+### Note
+When you import your projects from GitHub, it is not possible to keep your labels and milestones and issue numbers won't match. We are working on improving this in the near future. \ No newline at end of file