From 9d905fa78c7d77c1adbcefd0dbb76462db5d078f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89lie=20Bouttier?= Date: Tue, 12 May 2015 23:11:43 +0200 Subject: [PATCH] doc: upgrade guide --- doc/source/dev.rst | 4 ++-- doc/source/documentation.rst | 2 -- doc/source/index.rst | 5 +++-- doc/source/upgrade.rst | 41 ++++++++++++++++++++++++++++++++++++ doc/source/user.rst | 2 ++ 5 files changed, 48 insertions(+), 6 deletions(-) delete mode 100644 doc/source/documentation.rst create mode 100644 doc/source/upgrade.rst create mode 100644 doc/source/user.rst diff --git a/doc/source/dev.rst b/doc/source/dev.rst index eb5ba73..a273cd1 100644 --- a/doc/source/dev.rst +++ b/doc/source/dev.rst @@ -1,2 +1,2 @@ -Developers guide -################ +Developer guide +############### diff --git a/doc/source/documentation.rst b/doc/source/documentation.rst deleted file mode 100644 index d4a174a..0000000 --- a/doc/source/documentation.rst +++ /dev/null @@ -1,2 +0,0 @@ -Documentation -############# diff --git a/doc/source/index.rst b/doc/source/index.rst index fbd1d48..7f47c09 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -16,8 +16,9 @@ Contents: :maxdepth: 2 Installation - Documentation - Developers guide + Upgrade + User guide + Developer guide diff --git a/doc/source/upgrade.rst b/doc/source/upgrade.rst new file mode 100644 index 0000000..c769756 --- /dev/null +++ b/doc/source/upgrade.rst @@ -0,0 +1,41 @@ +Upgrade guide +############# + +The upgrade commands are executed as ``ponytracker`` user:: + + # su ponytracker + $ cd /srv/www/ponytracker + +Activate the virtualenv:: + + $ source env/bin/activate + +Enter in the repository directory:: + + $ cd ponytracker # we are now in /srv/www/ponytracker/ponytracker + +Upgrade the files using ``git``:: + + $ git pull -u master release + +Install all new dependencies and upgrade previous ones:: + + $ pip install -r requirements.txt --upgrade + +Be sure to use the correct configuration file each time you run the +``manage.py`` script by setting the ``DJANGO_SETTING_MODULE`` environment +variable:: + + $ export DJANGO_SETTINGS_MODULE=ponytracker.local_settings + +Collect static files to the ``STATIC_DIR``:: + + $ python manage.py collectstatic + +Apply database migrations:: + + $ python manage.py migrate + +You can now restart ponytracker by restarting ``gunicorn`` or ``uwsgi`` +depending of your installation. +Do not forget to restart the celery worker too if you have installed it. diff --git a/doc/source/user.rst b/doc/source/user.rst new file mode 100644 index 0000000..a288ad1 --- /dev/null +++ b/doc/source/user.rst @@ -0,0 +1,2 @@ +User guide +##########