summaryrefslogtreecommitdiff
path: root/doc/workflow
diff options
context:
space:
mode:
authorDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>2015-11-10 12:33:21 +0100
committerDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>2015-11-12 15:22:59 +0100
commit2ac1193720907bccc1f321e9c56fb5ca2b0a3a1c (patch)
tree40845b42c6e7668c8597cfbb9199a2249c42952f /doc/workflow
parent3c96ea766a60e15272f9d9ad1d331c9372465d6a (diff)
downloadgitlab-ce-2ac1193720907bccc1f321e9c56fb5ca2b0a3a1c.tar.gz
Add release notes documentation
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
Diffstat (limited to 'doc/workflow')
-rw-r--r--doc/workflow/README.md1
-rw-r--r--doc/workflow/releases.md20
-rw-r--r--doc/workflow/releases/new_tag.pngbin0 -> 154755 bytes
-rw-r--r--doc/workflow/releases/tags.pngbin0 -> 165449 bytes
4 files changed, 21 insertions, 0 deletions
diff --git a/doc/workflow/README.md b/doc/workflow/README.md
index 5b8d72dfd34..a2653704c33 100644
--- a/doc/workflow/README.md
+++ b/doc/workflow/README.md
@@ -13,5 +13,6 @@
- [Project users](add-user/add-user.md)
- [Protected branches](protected_branches.md)
- [Web Editor](web_editor.md)
+- [Releases](releases.md)
- [Merge Requests](merge_requests.md)
- ["Work In Progress" Merge Requests](wip_merge_requests.md)
diff --git a/doc/workflow/releases.md b/doc/workflow/releases.md
new file mode 100644
index 00000000000..0eca220e2cf
--- /dev/null
+++ b/doc/workflow/releases.md
@@ -0,0 +1,20 @@
+# Releases
+
+You can turn any git tag into release by just adding a release notes to it.
+Release notes behaves like any other markdown form in GitLab so you can write text and drag-n-drop files to it.
+Release notes are stored in GitLab database.
+
+There are several ways to add release notes:
+
+* In UI when you create new git tag with GitLab
+* In UI when you add release notes to existing git tag
+* with GitLab API
+
+## New tag page with release notes text area
+
+![new_tag](releases/new_tag.png)
+
+## Tags page with button to add or edit release notes for existing git tag
+
+![tags](releases/tags.png)
+
diff --git a/doc/workflow/releases/new_tag.png b/doc/workflow/releases/new_tag.png
new file mode 100644
index 00000000000..e2b64bfe17f
--- /dev/null
+++ b/doc/workflow/releases/new_tag.png
Binary files differ
diff --git a/doc/workflow/releases/tags.png b/doc/workflow/releases/tags.png
new file mode 100644
index 00000000000..aca91906c68
--- /dev/null
+++ b/doc/workflow/releases/tags.png
Binary files differ