From 6bc46290c0a71ac638aea9563eb1ddc84fae4eb3 Mon Sep 17 00:00:00 2001
From: Drew Kerrigan <dr.kerrigan@gmail.com>
Date: Wed, 3 Aug 2016 11:22:08 -0400
Subject: [PATCH] adding docs for releases

---
 .gitignore       |  1 -
 docs/RELEASES.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 61 insertions(+), 1 deletion(-)
 create mode 100644 docs/RELEASES.md

diff --git a/.gitignore b/.gitignore
index a19d068..8ab7fc1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,5 @@
 .eunit
 deps
-docs
 *.o
 *.plt
 erl_crash.dump
diff --git a/docs/RELEASES.md b/docs/RELEASES.md
new file mode 100644
index 0000000..a6bfd05
--- /dev/null
+++ b/docs/RELEASES.md
@@ -0,0 +1,61 @@
+# Riak Explorer Releases
+
+## Requirements
+
+1. MacOSX machine
+2. Ubuntu 14.04 machine
+3. CentOS 7 machine
+4. Github oauth token
+
+## Tag
+
+1. Visit https://github.com/basho-labs/riak_explorer/releases and click `Draft a new release`.
+2. Create a new tag and release with the naming convention X.X.X (i.e. `1.1.3`)
+
+## Clone
+
+SSH into each of the 3 machines listed above and run the following
+
+```
+git clone https://github.com/basho-labs/riak_explorer.git
+cd riak_explorer
+echo "YOUR_OAUTH_TOKEN" > oauth.txt
+```
+
+## Build and Upload
+
+* OSX
+
+```
+OS_FAMILY=osx OS_VERSION=10.11 make tarball
+OS_FAMILY=osx OS_VERSION=10.11 make tarball-standalone
+OS_FAMILY=osx OS_VERSION=10.11 make sync
+OS_FAMILY=osx OS_VERSION=10.11 make sync-standalone
+```
+
+* Ubuntu
+
+```
+OS_FAMILY=ubuntu OS_VERSION=14.04 make tarball
+OS_FAMILY=ubuntu OS_VERSION=14.04 make tarball-standalone
+OS_FAMILY=ubuntu OS_VERSION=14.04 make sync
+OS_FAMILY=ubuntu OS_VERSION=14.04 make sync-standalone
+```
+
+* CentOS
+
+```
+OS_FAMILY=centos OS_VERSION=7 make tarball
+OS_FAMILY=centos OS_VERSION=7 make tarball-standalone
+OS_FAMILY=centos OS_VERSION=7 make sync
+OS_FAMILY=centos OS_VERSION=7 make sync-standalone
+```
+
+## Verify
+
+1. Navigate to https://github.com/basho-labs/riak_explorer/releases/tag/YOUR_TAG
+2. Verify that all 3 sets of the following files are listed as downloads for the release:
+   a. riak_explorer-X.X.X-OS_FAMILY-OS_VERSION-tar.gz
+   b. riak_explorer-X.X.X-OS_FAMILY-OS_VERSION-tar.gz.sha
+   c. riak_explorer-X.X.X.patch-OS_FAMILY-OS_VERSION-tar.gz
+   d. riak_explorer-X.X.X.patch-OS_FAMILY-OS_VERSION-tar.gz.sha