summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-10-02 19:42:34 +0000
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-10-02 19:42:34 +0000
commit9235f1d491f83638b0f199fb78bc09f04660f450 (patch)
treefdb56b55fc931089b38d0f19f633e5aabb7d94a5
parent77f832d81385972da1265cff9f9fb4bc153a7af5 (diff)
parent267a96f3d42c1cdd38fc1424fe2e53ede8bd9950 (diff)
downloadgitlab-ce-9235f1d491f83638b0f199fb78bc09f04660f450.tar.gz
Merge branch 'link-to-downtime-requires-from-migration-style-guide' into 'master'
Link to the "What requires downtime?" page from the Migration Style Guide ## What does this MR do? Adds a link from migration style guide -> "What requires downtime?" ## Are there points in the code the reviewer needs to double check? ## Why was this MR needed? The two pages really need to be read together, so having the link is helpful. ## Screenshots (if relevant) ## Does this MR meet the acceptance criteria? - [ ] [CHANGELOG](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CHANGELOG) entry added - [ ] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md) - [ ] API support added - Tests - [ ] Added for this feature/bug - [ ] All builds are passing - [ ] Conform by the [merge request performance guides](http://docs.gitlab.com/ce/development/merge_request_performance_guidelines.html) - [ ] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides) - [ ] Branch has no merge conflicts with `master` (if you do - rebase it please) - [ ] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits) ## What are the relevant issue numbers? See merge request !6636
-rw-r--r--doc/development/migration_style_guide.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/development/migration_style_guide.md b/doc/development/migration_style_guide.md
index 295eae0a88e..61b0fbc89c9 100644
--- a/doc/development/migration_style_guide.md
+++ b/doc/development/migration_style_guide.md
@@ -9,10 +9,10 @@ a big burden for most organizations. For this reason it is important that your
migrations are written carefully, can be applied online and adhere to the style guide below.
Migrations should not require GitLab installations to be taken offline unless
-_absolutely_ necessary. If a migration requires downtime this should be
-clearly mentioned during the review process as well as being documented in the
-monthly release post. For more information see the "Downtime Tagging" section
-below.
+_absolutely_ necessary - see the ["What Requires Downtime?"](what_requires_downtime.md)
+page. If a migration requires downtime, this should be clearly mentioned during
+the review process, as well as being documented in the monthly release post. For
+more information, see the "Downtime Tagging" section below.
When writing your migrations, also consider that databases might have stale data
or inconsistencies and guard for that. Try to make as little assumptions as possible