diff --git a/docs/upgrade.rst b/docs/upgrade.rst --- a/docs/upgrade.rst +++ b/docs/upgrade.rst @@ -3,10 +3,13 @@ Upgrade ======= -Upgrade from Cheese Shop ------------------------- +Upgrading from Cheese Shop +-------------------------- -Easiest way to upgrade ``rhodecode`` is to run:: +.. note:: + Firstly, it is recommended that you **always** perform a database backup before doing an upgrade. + +The easiest way to upgrade ``rhodecode`` is to run:: easy_install -U rhodecode @@ -15,39 +18,31 @@ Or:: pip install --upgrade rhodecode -Then make sure You run from the installation directory - -:: +Then make sure you run the following command from the installation directory:: paster make-config RhodeCode production.ini -This will display any changes made from new version of RhodeCode To your -current config. And tries to do an automerge. It's always better to do a backup -of config file and recheck the content after merge. +This will display any changes made by the new version of RhodeCode to your +current configuration. It will try to perform an automerge. It's always better +to make a backup of your configuration file before hand and recheck the content after the automerge. .. note:: The next steps only apply to upgrading from non bugfix releases eg. from - 1.1 to 1.2. Bugfix releases (eg. 1.1.2->1.1.3) will not have any database - schema changes or whoosh library updates + any minor or major releases. Bugfix releases (eg. 1.1.2->1.1.3) will + not have any database schema changes or whoosh library updates. -It's also good to rebuild the whoosh index since after upgrading the whoosh -version there could be introduced incompatible index changes. +It is also recommended that you rebuild the whoosh index after upgrading since the new whoosh +version could introduce some incompatible index changes. -The last step is to upgrade the database. To do this simply run - -:: +The final step is to upgrade the database. To do this simply run:: paster upgrade-db production.ini -This will upgrade schema, as well as update some default on the database, -always recheck the settings of the application, if there are no new options +This will upgrade the schema and update some of the defaults in the database, +and will always recheck the settings of the application, if there are no new options that need to be set. -.. note:: - Always perform a database backup before doing upgrade. - - .. _virtualenv: http://pypi.python.org/pypi/virtualenv .. _python: http://www.python.org/