tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 12:05:37 +00:00
Code Issues Projects Releases Wiki Activity

MINOR Improved upgrading docs (fixes #7508)

Browse Source
This commit is contained in:
Ingo Schommer 2012-06-26 13:49:06 +02:00
parent d935a74e31
commit 56a3777c42
1 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/en/installation/upgrading.md
View File

@ -1,40 +1,41 @@
# Upgrading # Upgrading
Usually an update or upgrade your SilverStripe installation just means overwriting files and updating your Usually an update or upgrade your SilverStripe installation just means
database-schema. Please see your [upgrade notes and changelogs](/changelogs). overwriting files and updating your database-schema.
See our [upgrade notes and changelogs](/changelogs) for release-specific information.
## Process ## Process
Never update a website on the live server without trying it on a development copy first.
* Check if any modules (e.g. blog or forum) in your installation are compatible and need to be upgraded as well * Check if any modules (e.g. blog or forum) in your installation are compatible and need to be upgraded as well
* Backup your database * Backup your database content
* Backup your website * Backup your webroot files
* Download the new release and uncompress it to a temporary folder * Download the new release and uncompress it to a temporary folder
* Leave custom folders like *mysite* or *themes* in place. * Leave custom folders like *mysite* or *themes* in place.
* Identify system folders in your webroot (`cms`, `framework` and any additional modules). * Identify system folders in your webroot (`cms`, `framework`, `sapphire` and any additional modules).
* Delete existing system folders (or move them outside of your webroot) * Delete existing system folders (or move them outside of your webroot)
* Extract and replace system folders from your download (Deleting instead of "copying over" existing folders * Extract and replace system folders from your download (Deleting instead of "copying over" existing folders ensures that files removed from the new SilverStripe release are not persisting in your installation)
ensures that files removed from the new SilverStripe release are not persisting in your installation) * Visit http://yoursite.com/dev/build/?flush=1 to rebuild the website database
* Check if you need to adapt your code to changed PHP APIs
* Check if you have overwritten any core templates or styles which might need an update
* See [common-problems](common-problems) for a list of likely mistakes that could happen during an upgrade.
* Visit http://yoursite.com/dev/build/?flush=1 to rebuild the website Database <div class="warning" markdown="1">
* Check if you need to adapt your code to changed APIs Never update a website on the live server without trying it on a development copy first.
* Check if you need to adapt your code to changed CSS/HTML/JS </div>
* See [common-problems](common-problems) for a list of likely mistakes that could happen during an upgrade.
## Decision Helpers ## Decision Helpers
How easy will it be to update my project? It's a fair question, and sometimes a difficult one to answer. This page is How easy will it be to update my project? It's a fair question, and sometimes a difficult one to answer.
intended to help you work out how hard it will be to upgrade your site.
* If you've made custom branches of the core, or of a module, it's going to be harder to upgrade. * "Micro" releases (x.y.z) are explicitly backwards compatible, "minor" and "major" releases can deprecate features and change APIs (see our [/misc/release-process](release process) for details)
* The more custom features you have, the harder it will be to upgrade. You will have to re-test all of those features * If you've made custom branches of SilverStripe core, or any thirdparty module, it's going to be harder to upgrade.
and some of them may have broken. * The more custom features you have, the harder it will be to upgrade. You will have to re-test all of those features, and adapt to API changes in core.
* Customisations of a well defined type - such as custom page types or custom blog widgets - are going to be easier to * Customisations of a well defined type - such as custom page types or custom blog widgets - are going to be easier to upgrade than customisations that modify deep system internals like rewriting SQL queries.
upgrade than customisations that use sneaky tricks, such as the subsites module.
## Related ## Related
* [Release Announcements](http://groups.google.com/group/silverstripe-announce/) * [Release Announcements](http://groups.google.com/group/silverstripe-announce/)
* [Blog posts about releases on silverstripe.org](http://silverstripe.org/blog/tag/release) * [Blog posts about releases on silverstripe.org](http://silverstripe.org/blog/tag/release)
* [/misc/release-process](Release Process)