From c5564fade10e16a0f0e3f21b368d17ced5b747fe Mon Sep 17 00:00:00 2001 From: James Lopez Date: Thu, 31 Aug 2017 14:14:19 +0200 Subject: Fix some typos in doc --- .../raketasks/project_import_export.md | 4 ++-- lib/gitlab/import_export/README.md | 20 ++++++++++---------- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/administration/raketasks/project_import_export.md b/doc/administration/raketasks/project_import_export.md index 628e4fb69ff..d3bede53f7b 100644 --- a/doc/administration/raketasks/project_import_export.md +++ b/doc/administration/raketasks/project_import_export.md @@ -42,10 +42,10 @@ An existing exported project file can be scheduled to be imported using the foll bundle exec rake gitlab:import_export:import['namespace/test_project_export',root,'/path/to/project_export.tar.gz'] ``` -The status of any import os export can be checked at any time using the following task: +The status of any import or export can be checked at any time using the following task: ```bash -bundle exec rake gitlab:import_export:status['namespace/test_project_export'] # check the status of the import +bundle exec rake gitlab:import_export:status['namespace/test_project_export'] ``` [ce-3050]: https://gitlab.com/gitlab-org/gitlab-ce/issues/3050 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. + **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) @@ -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) -- cgit v1.2.1