From acb630b062575981c536f69079244013d27bf4e9 Mon Sep 17 00:00:00 2001
From: Sam Gleske <sag47@drexel.edu>
Date: Fri, 8 Nov 2013 15:42:26 -0500
Subject: [PATCH] Adding upgrade docs

---
 docs/update/update_0.2.x-0.3.x.md   | 36 +++++++++++++++++++++++++++++
 docs/upgrade/upgrade_0.2.x-0.3.x.md | 36 +++++++++++++++++++++++++++++
 2 files changed, 72 insertions(+)
 create mode 100644 docs/update/update_0.2.x-0.3.x.md
 create mode 100644 docs/upgrade/upgrade_0.2.x-0.3.x.md

diff --git a/docs/update/update_0.2.x-0.3.x.md b/docs/update/update_0.2.x-0.3.x.md
new file mode 100644
index 0000000..06a04b1
--- /dev/null
+++ b/docs/update/update_0.2.x-0.3.x.md
@@ -0,0 +1,36 @@
+# Upgrade Notes
+
+This documentation outlines steps for you to upgrade from gitlab-mirrors `0.2.x` to gitlab-mirrors `0.3.x`.  It is assumed you'll be working on a test instance of gitlab in a production environment.  If you only have a single gitlab instance then follow these steps with care and at your own risk.
+
+gitlab-mirrors has been certified to use a new prerequisite library called [pyapi-gitlab](https://github.com/Itxaka/pyapi-gitlab) (formerly called python-gitlab).  Therefore you must install `pyapi-gitlab` before upgrading `gitlab-mirrors` to the latest edition.
+
+# 1. Disable any cron jobs
+
+If you have cron jobs set up then you'll need to disable them to avoid them launching gitlab-mirrors during your upgrade.
+
+# 2. Update python-gitlab to pyapi-gitlab
+
+I'll ouline the steps here real quick.
+
+    cd /usr/local/src
+    git checkout https://github.com/Itxaka/pyapi-gitlab.git
+    git checkout 4d778d780161869550d8e514cdc50df2398f844e
+    python setup.py install
+
+You must remove the previous conflicting library from `/usr/local/lib/python2.7/dist-packages/python_gitlab-0.1-py2.7.egg` by default on my system.  Your system may vary the location.  If you're not sure where it's at then you can locate it using `mlocate` package in RHEL.
+
+    yum install mlocate
+    updatedb
+    locate *.egg
+    rm -rf /usr/local/lib/python2.7/dist-packages/python_gitlab-0.1-py2.7.egg
+
+# 3. Update your gitlab-mirrors
+
+    su - gitmirror
+    cd gitlab-mirrors
+    git checkout master
+    git fetch
+    git pull origin master
+    git checkout v0.3.0
+
+Test on a dummy project to ensure your new setup works.  Once you have verified everything works then you can re-enable the cron jobs.
diff --git a/docs/upgrade/upgrade_0.2.x-0.3.x.md b/docs/upgrade/upgrade_0.2.x-0.3.x.md
new file mode 100644
index 0000000..06a04b1
--- /dev/null
+++ b/docs/upgrade/upgrade_0.2.x-0.3.x.md
@@ -0,0 +1,36 @@
+# Upgrade Notes
+
+This documentation outlines steps for you to upgrade from gitlab-mirrors `0.2.x` to gitlab-mirrors `0.3.x`.  It is assumed you'll be working on a test instance of gitlab in a production environment.  If you only have a single gitlab instance then follow these steps with care and at your own risk.
+
+gitlab-mirrors has been certified to use a new prerequisite library called [pyapi-gitlab](https://github.com/Itxaka/pyapi-gitlab) (formerly called python-gitlab).  Therefore you must install `pyapi-gitlab` before upgrading `gitlab-mirrors` to the latest edition.
+
+# 1. Disable any cron jobs
+
+If you have cron jobs set up then you'll need to disable them to avoid them launching gitlab-mirrors during your upgrade.
+
+# 2. Update python-gitlab to pyapi-gitlab
+
+I'll ouline the steps here real quick.
+
+    cd /usr/local/src
+    git checkout https://github.com/Itxaka/pyapi-gitlab.git
+    git checkout 4d778d780161869550d8e514cdc50df2398f844e
+    python setup.py install
+
+You must remove the previous conflicting library from `/usr/local/lib/python2.7/dist-packages/python_gitlab-0.1-py2.7.egg` by default on my system.  Your system may vary the location.  If you're not sure where it's at then you can locate it using `mlocate` package in RHEL.
+
+    yum install mlocate
+    updatedb
+    locate *.egg
+    rm -rf /usr/local/lib/python2.7/dist-packages/python_gitlab-0.1-py2.7.egg
+
+# 3. Update your gitlab-mirrors
+
+    su - gitmirror
+    cd gitlab-mirrors
+    git checkout master
+    git fetch
+    git pull origin master
+    git checkout v0.3.0
+
+Test on a dummy project to ensure your new setup works.  Once you have verified everything works then you can re-enable the cron jobs.
-- 
GitLab