diff --git a/docs/user-guide/upgrading.md b/docs/user-guide/upgrading.md new file mode 100644 index 0000000..e55f288 --- /dev/null +++ b/docs/user-guide/upgrading.md @@ -0,0 +1,14 @@ +# Upgrading Polr +----------------- +To upgrade your Polr instance to the latest `master` or to a new release, you must back up your database and files before proceeding to avoid data loss. + +## Upgrading from 2.x: + +- Back up your database and files +- Update your files by using `git pull` or downloading a release +- Run `composer install --no-dev -o` to ensure dependencies are up to date +- Migrate database with `php artisan migrate` to ensure database structure is up to date + +## Upgrading from 1.x: + +There are breaking changes between 2.x and 1.x; it is not yet possible to automatically upgrade to 2.x. diff --git a/mkdocs.yml b/mkdocs.yml index dba877f..81f9b7a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,6 +3,7 @@ pages: - Home: index.md - User Guide: - 'Installation': 'user-guide/installation.md' + - 'Upgrading': 'user-guide/upgrading.md' - 'Troubleshooting': 'user-guide/troubleshooting.md' - Developer Guide: - 'Libraries': 'developer-guide/libraries.md'