summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-06-21 20:07:52 +0200
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-06-21 20:07:52 +0200
commitb2732f3af104fe31aed126505a5b7e4fa1a62f71 (patch)
tree01ede4c37e62a6dfac2232c69a9c99f6fd4972c9 /doc
parent0c61fad74c877ff797578a3cb969c6e613b8df00 (diff)
downloadgitlab-ce-b2732f3af104fe31aed126505a5b7e4fa1a62f71.tar.gz
Refactor project import/export documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/administration/raketasks/project_import_export.md28
-rw-r--r--doc/user/project/settings/img/settings_edit_button.pngbin0 -> 19392 bytes
-rw-r--r--doc/user/project/settings/import_export.md76
3 files changed, 66 insertions, 38 deletions
diff --git a/doc/administration/raketasks/project_import_export.md b/doc/administration/raketasks/project_import_export.md
new file mode 100644
index 00000000000..e5cb0308cbb
--- /dev/null
+++ b/doc/administration/raketasks/project_import_export.md
@@ -0,0 +1,28 @@
+# Project import/export
+
+>**Note:**
+ - This feature was [introduced][ce-3050] in GitLab 8.9
+ - Importing will not be possible if the import instance version is lower
+ than that of the exporter.
+
+The GitLab Import/Export version can be checked by using:
+
+```bash
+# Omnibus installations
+sudo gitlab-rake gitlab:import_export:version
+
+# Installations from source
+bundle exec rake gitlab:import_export:version RAILS_ENV=production
+```
+
+The current list of DB tables that will get exported can be listed by using:
+
+```bash
+# Omnibus installations
+sudo gitlab-rake gitlab:import_export:data
+
+# Installations from source
+bundle exec rake gitlab:import_export:data RAILS_ENV=production
+```
+
+[ce-3050]: https://gitlab.com/gitlab-org/gitlab-ce/issues/3050
diff --git a/doc/user/project/settings/img/settings_edit_button.png b/doc/user/project/settings/img/settings_edit_button.png
new file mode 100644
index 00000000000..3c0cee536de
--- /dev/null
+++ b/doc/user/project/settings/img/settings_edit_button.png
Binary files differ
diff --git a/doc/user/project/settings/import_export.md b/doc/user/project/settings/import_export.md
index 618f9948e12..7cc31e9dc4e 100644
--- a/doc/user/project/settings/import_export.md
+++ b/doc/user/project/settings/import_export.md
@@ -1,65 +1,65 @@
# Project import/export
+>**Note:**
+ - This feature was [introduced][ce-3050] in GitLab 8.9
+ - Importing will not be possible if the import instance version is lower
+ than that of the exporter.
+ - You can find some useful raketasks if you are an administrator in the
+ [project_import_export](../../../administration/raketasks/project_import_export.md)
+ raketask.
+
Existing projects running on any GitLab instance or GitLab.com can be exported
with all their related data and be moved into a new GitLab instance.
->**Note:**
- - This feature was [introduced][ce-3050] in GitLab 8.9
- - Importing will not be possible if the import instance version is lower
- than that of the exporter.
-
## Exported contents
-
-- The following items will be exported:
- - Project and wiki repositories
- - Project uploads
- - Project configuration including web hooks and services
- - Issues with comments, merge requests with diffs and comments, labels, milestones, snippets,
- and other project entities
-- The following items will NOT be exported:
- - Build traces and artifacts
- - LFS objects
-## Exporting a project and its data
+The following items will be exported:
-1. Go to the project settings page and find the Export button
+- Project and wiki repositories
+- Project uploads
+- Project configuration including web hooks and services
+- Issues with comments, merge requests with diffs and comments, labels, milestones, snippets,
+ and other project entities
- ![export_1](./img/export_1.png)
+The following items will NOT be exported:
-1. Once the export is generated, you should receive an e-mail with a link to download the file
+- Build traces and artifacts
+- LFS objects
- ![export_3](./img/export_3.png)
+## Exporting a project and its data
-1. You can come back to project settings and download the file from there, or delete it so it
-can be generated again
+1. Go to the project settings page by clicking on **Edit Project**
- ![export_4](./img/export_4.png)
+ ![Project settings button](img/settings_edit_button.png)
-## Importing the project
+1. Scroll down to find the **Export project** button
-1. The new GitLab project import feature is at the far right of the import options on New Project
+ ![export_1](./img/export_1.png)
- ![import_1](./img/import_1.png)
+1. Once the export is generated, you should receive an e-mail with a link to
+ download the file
-1. After choosing a namespace or path, you can then select the file exported previously
+ ![export_3](./img/export_3.png)
- ![import_2](./img/import_2.png)
+1. Alternatively, you can come back to the project settings and download the
+ file from there, or generate a new export
-1. Click on Import to begin importing and you will see your newly imported project page soon
+ ![export_4](./img/export_4.png)
+## Importing the project
-## Advanced
+1. The new GitLab project import feature is at the far right of the import
+ options when creating a New Project. Make sure you are in the right namespace
+ and you have entered a project name. Click on **GitLab export**
-The GitLab Import/Export version can be checked by using:
+ ![import_1](./img/import_1.png)
-```bash
-sudo gitlab-rake gitlab:import_export:version
-```
+1. You can see where the project will be imported to. You can now select file
+ exported previously
-The current list of DB tables that will get exported can be listed by using:
+ ![import_2](./img/import_2.png)
-```bash
-sudo gitlab-rake gitlab:import_export:data
-```
+1. Click on **Import project** to begin importing. Your newly imported project
+ page will appear soon
[ce-3050]: https://gitlab.com/gitlab-org/gitlab-ce/issues/3050