diff --git a/docs/install.rst b/docs/install.rst index 0c39f1e..eb82101 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -114,7 +114,7 @@ Upgrading to a new Open edX release Major Open edX releases are published twice a year, in June and December, by the Open edX `Build/Test/Release working group `__. When a new Open edX release comes out, Tutor gets a major version bump (see :ref:`versioning`). Such an upgrade typically includes multiple breaking changes. Any upgrade is final because downgrading is not supported. Thus, when upgrading your platform from one major version to the next, it is strongly recommended to do the following: 1. Read the changes listed in the `CHANGELOG.md `__ file. Breaking changes are identified by a "💥". -2. Perform a backup. On a local installation, this is typically done with:: +2. Perform a backup (see the :ref:`backup tutorial `). On a local installation, this is typically done with:: tutor local stop sudo rsync -avr "$(tutor config printroot)"/ /tmp/tutor-backup/ diff --git a/docs/tutorials/datamigration.rst b/docs/tutorials/datamigration.rst index 95bfb86..8434eee 100644 --- a/docs/tutorials/datamigration.rst +++ b/docs/tutorials/datamigration.rst @@ -1,3 +1,5 @@ +.. _backup_tutorial: + Making backups and migrating data --------------------------------- @@ -10,7 +12,7 @@ With Tutor, all data are stored in a single folder. This means that it's extreme 3. Transfer the configuration, environment, and platform data from server 1 to server 2:: - rsync -avr "$(tutor config printroot)/" username@server2:/tmp/tutor/ + sudo -avr "$(tutor config printroot)/" username@server2:/tmp/tutor/ 4. On server 2, move the data to the right location::