summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>2015-06-05 13:35:16 +0000
committerDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>2015-06-05 13:35:16 +0000
commit6f7bf4e4f0ea40c4f69354b8ce75c77af4fab5cb (patch)
tree859db1da940acd1bcc793abd86eee4e40b0816e2
parent3b9792ec72e9bb00305fb85ed6fb164211903147 (diff)
parentbdfd163aa1474c8fba76fb1730ee9df09f67cc69 (diff)
downloadgitlab-ce-6f7bf4e4f0ea40c4f69354b8ce75c77af4fab5cb.tar.gz
Merge branch 'wip-mr-docs' into 'master'
Add info about WIP merge requests to docs. Addresses internal issue https://dev.gitlab.org/gitlab/gitlabhq/issues/2078. See merge request !770
-rw-r--r--app/views/projects/merge_requests/show/_mr_accept.html.haml6
-rw-r--r--doc/workflow/README.md1
-rw-r--r--doc/workflow/wip_merge_requests.md13
-rw-r--r--doc/workflow/wip_merge_requests/blocked_accept_button.pngbin0 -> 65231 bytes
-rw-r--r--doc/workflow/wip_merge_requests/mark_as_wip.pngbin0 -> 41549 bytes
-rw-r--r--doc/workflow/wip_merge_requests/unmark_as_wip.pngbin0 -> 32151 bytes
6 files changed, 17 insertions, 3 deletions
diff --git a/app/views/projects/merge_requests/show/_mr_accept.html.haml b/app/views/projects/merge_requests/show/_mr_accept.html.haml
index 906cc11dc67..bfd4ab6f3d8 100644
--- a/app/views/projects/merge_requests/show/_mr_accept.html.haml
+++ b/app/views/projects/merge_requests/show/_mr_accept.html.haml
@@ -49,7 +49,7 @@
.automerge_widget.cannot_be_merged.hide
%h4
- This pull request contains merge conflicts that must be resolved.
+ This merge request contains merge conflicts that must be resolved.
You can try it manually on the
%strong
= link_to "command line", "#modal_merge_info", class: "how_to_merge_link vlink", title: "How To Merge", "data-toggle" => "modal"
@@ -63,14 +63,14 @@
.automerge_widget.work_in_progress.hide
%h4
- This request cannot be merged because it is marked as <strong>Work In Progress</strong>.
+ This merge request cannot be accepted because it is marked as Work In Progress.
%p
%button.btn.disabled{:type => 'button'}
%i.fa.fa-warning
Accept Merge Request
&nbsp;
- When the merge request is ready, remove the "WIP" prefix from the title to allow merging.
+ When the merge request is ready, remove the "WIP" prefix from the title to allow it to be accepted.
.automerge_widget.unchecked
%p
diff --git a/doc/workflow/README.md b/doc/workflow/README.md
index 89005e51958..4775be15040 100644
--- a/doc/workflow/README.md
+++ b/doc/workflow/README.md
@@ -16,3 +16,4 @@
- [Change your time zone](timezone.md)
- [Keyboard shortcuts](shortcuts.md)
- [Web Editor](web_editor.md)
+- ["Work In Progress" Merge Requests](wip_merge_requests.md)
diff --git a/doc/workflow/wip_merge_requests.md b/doc/workflow/wip_merge_requests.md
new file mode 100644
index 00000000000..46035a5e6b6
--- /dev/null
+++ b/doc/workflow/wip_merge_requests.md
@@ -0,0 +1,13 @@
+# "Work In Progress" Merge Requests
+
+To prevent merge requests from accidentally being accepted before they're completely ready, GitLab blocks the "Accept" button for merge requests that have been marked a **Work In Progress**.
+
+![Blocked Accept Button](wip_merge_requests/blocked_accept_button.png)
+
+To mark a merge request a Work In Progress, simply start its title with `[WIP]` or `WIP:`.
+
+![Mark as WIP](wip_merge_requests/mark_as_wip.png)
+
+To allow a Work In Progress merge request to be accepted again when it's ready, simply remove the `WIP` prefix.
+
+![Unark as WIP](wip_merge_requests/unmark_as_wip.png)
diff --git a/doc/workflow/wip_merge_requests/blocked_accept_button.png b/doc/workflow/wip_merge_requests/blocked_accept_button.png
new file mode 100644
index 00000000000..4791e5de972
--- /dev/null
+++ b/doc/workflow/wip_merge_requests/blocked_accept_button.png
Binary files differ
diff --git a/doc/workflow/wip_merge_requests/mark_as_wip.png b/doc/workflow/wip_merge_requests/mark_as_wip.png
new file mode 100644
index 00000000000..8fa83a201ac
--- /dev/null
+++ b/doc/workflow/wip_merge_requests/mark_as_wip.png
Binary files differ
diff --git a/doc/workflow/wip_merge_requests/unmark_as_wip.png b/doc/workflow/wip_merge_requests/unmark_as_wip.png
new file mode 100644
index 00000000000..d45e68f31c5
--- /dev/null
+++ b/doc/workflow/wip_merge_requests/unmark_as_wip.png
Binary files differ