summaryrefslogtreecommitdiff
path: root/lib/gitlab/import_export/README.md
diff options
context:
space:
mode:
authorJames Lopez <james@jameslopez.es>2017-08-31 14:14:19 +0200
committerJames Lopez <james@jameslopez.es>2017-08-31 14:14:19 +0200
commitc5564fade10e16a0f0e3f21b368d17ced5b747fe (patch)
tree8bbe7f981157f1135f4b46da52fa949bfe1e89cf /lib/gitlab/import_export/README.md
parent125e46d59e44a1d04583667ea6385891cdaf4a4c (diff)
downloadgitlab-ce-c5564fade10e16a0f0e3f21b368d17ced5b747fe.tar.gz
Diffstat (limited to 'lib/gitlab/import_export/README.md')
-rw-r--r--lib/gitlab/import_export/README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/lib/gitlab/import_export/README.md b/lib/gitlab/import_export/README.md
index 71827534cf6..5067adb4769 100644
--- a/lib/gitlab/import_export/README.md
+++ b/lib/gitlab/import_export/README.md
@@ -1,16 +1,16 @@
# GitLab Import/Export developer documentation
+See [Import/Export documentation](../../../doc/user/project/settings/import_export.md) for details about Import/Export.
+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**
-- [GitLab Import/Export developer documentation](#gitlab-importexport-developer-documentation)
- - [Breaking changes](#breaking-changes)
- - [Failing specs](#failing-specs)
- - [Adding a new sensitive word (such as `pass`) will make the feature spec `export_file_spec.rb` to fail.](#adding-a-new-sensitive-word-such-as-pass-will-make-the-feature-spec-export_file_specrb-to-fail)
- - [Adding a new model - `model_configuration_spec.rb`](#adding-a-new-model---model_configuration_specrb)
- - [Adding/Removing attributes - `attribute_configuration_spec.rb`](#addingremoving-attributes---attribute_configuration_specrb)
- - [Bumping the version number](#bumping-the-version-number)
+- [Breaking changes](#breaking-changes)- [Failing specs](#failing-specs)
+ - [Adding a new sensitive word (such as `pass`) will make the feature spec `export_file_spec.rb` to fail.](#adding-a-new-sensitive-word-such-as-pass-will-make-the-feature-spec-export_file_specrb-to-fail)
+ - [Adding a new model - `model_configuration_spec.rb`](#adding-a-new-model---model_configuration_specrb)
+ - [Adding/Removing attributes - `attribute_configuration_spec.rb`](#addingremoving-attributes---attribute_configuration_specrb)
+- [Bumping the version number](#bumping-the-version-number)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -37,9 +37,9 @@ in the DB has changed that needs an update in the Import/Export.
### Adding a new model - `model_configuration_spec.rb`
-Because we may want to export and not forget that new model you have added, we have to choose between:
+In order not to forget a new model/table recently added, we have to choose between:
-- If we also want to export/import the model, we have to add it to the `import_export.yml`. Make sure
+- In case we want to export/import the model, we have to add it to the `import_export.yml`. Make sure
it's at the right level. Also add it to `all_models.yml`, to acknowledge that it has been resolved.
- If you don't want to export the model, add it to `all_models.yml` at the right level. It will simply
be ignored and the test will pass.
@@ -50,7 +50,7 @@ be ignored and the test will pass.
This is mainly a security measure, to make sure that new attributes added to a model will be exported.
The attributes will be exported automatically, but we need to know they are safe to be exported.
-- If it's safe to export/import this attributes, simply add them to `safe_model_attributes.yml`
+- If it's safe to export/import these attributes, simply add them to `safe_model_attributes.yml`
- If you don't want those attributes to be exported/imported, blacklist them in `import_export.yml`
(`excluded_attributes` section)