aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing.rst4
-rw-r--r--docs/installation.rst2
-rw-r--r--docs/upgrade.rst10
3 files changed, 15 insertions, 1 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index b27e3f9..4b9e58b 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -166,3 +166,7 @@ Once this is done, use the "release" instruction:
$ make release
And the new version should be published on PyPI.
+
+.. note:: The above command will prompt for version number, handle
+ :file:`CHANGELOG.rst` and :file:`setup.py` updates, package creation,
+ pypi upload. It will prompt you before each step to get your consent.
diff --git a/docs/installation.rst b/docs/installation.rst
index f4744ae..38374e9 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -134,7 +134,7 @@ With Nginx, Gunicorn and Supervisord
ihatemoney generate-config supervisord.conf > /etc/supervisor/conf.d/ihatemoney.conf
-4. Copy (and adapt) output of ``ihatemoney generate-config conf/nginx.conf`` with your nginx vhosts [#nginx-vhosts]_
+4. Copy (and adapt) output of ``ihatemoney generate-config nginx.conf`` with your nginx vhosts [#nginx-vhosts]_
5. Reload both nginx and supervisord. It should be working ;)
.. [#nginx-vhosts] typically, */etc/nginx/conf.d/* or
diff --git a/docs/upgrade.rst b/docs/upgrade.rst
index 702008b..e48edcb 100644
--- a/docs/upgrade.rst
+++ b/docs/upgrade.rst
@@ -8,6 +8,8 @@ it before upgrading.
Ihatemoney follows `semantic versioning <http://semver.org/>`_. So minor/patch
upgrades can be done blindly.
+.. _general-procedure:
+
General procedure
=================
@@ -33,6 +35,14 @@ Version-specific instructions
When upgrading from a major version to another, you **must** follow special
instructions:
+2.x → 3.x
+---------
+
+Sentry support has been removed. Sorry if you used it.
+
+Appart from that, :ref:`general-procedure` applies.
+
+
1.x → 2.x
---------