[Plone-cvs] r24006 - Plone/tags/3.2/docs

[Wichert A. <svn...@pl...>]

Author: wichert
Date: Wed Dec 31 15:33:11 2008
New Revision: 24006

Modified:
   Plone/tags/3.2/docs/NEWS.txt
   Plone/tags/3.2/docs/RELEASENOTES.txt
Log:
Merge the upgrade instructions in the release notes

Modified: Plone/tags/3.2/docs/NEWS.txt
==============================================================================
--- Plone/tags/3.2/docs/NEWS.txt	(original)
+++ Plone/tags/3.2/docs/NEWS.txt	Wed Dec 31 15:33:11 2008
@@ -5,6 +5,15 @@
 Changelog
 =========
 
+3.2 - December 31, 2008
+-----------------------
+
+- Merge the upgrade instructions from
+  http://plone.org/documentation/manual/upgrade-guide/version/upgrading-from-3-x-to-3.2
+  into the release notes.
+  [wichert]
+
+
 3.2rc1 - December 15, 2008
 --------------------------
 

Modified: Plone/tags/3.2/docs/RELEASENOTES.txt
==============================================================================
--- Plone/tags/3.2/docs/RELEASENOTES.txt	(original)
+++ Plone/tags/3.2/docs/RELEASENOTES.txt	Wed Dec 31 15:33:11 2008
@@ -1,3 +1,126 @@
+Plone 3.2 - Dec, 2008
+=====================
+
+Beginning with Plone 3.2, Plone will be available as a Python package and via
+installers. It will no longer be distributed as a tarball of old-fashioned Zope
+products. The change to standard Python packaging will improve dependency
+handling and make future installations easier. But, it will require some
+adjustments for those used to installing via a tarball of products. The 3.2
+installation will also require some slight changes in the buildout
+configuration file for those who have already been using buildout configuration
+management in the 3.x series.
+
+Plone's installers take care of all this for you, but if you aren't using one
+of the installers you'll need to learn buildout -- a Python configuration
+management tool we highly recommend -- or use the Python package installer,
+easy_install, to install Plone. Both methods are discussed below.
+
+Windows Updates
+---------------
+Users of past Windows installers should note: you should not try to simply
+install on top of your old Windows installation. That might have worked in the
+past, but it won't work with this upgrade. The move to a buildout-based
+installer has changed the layout of the subdirectories inside the installation.
+Do a new installation, get it working with all required products, then copy
+your old Data.fs file over the matching file in the new installation.
+
+Buildout
+--------
+All Plone's current installers use Buildout for configuration management. You
+should too, unless you're very experienced with Python packages. Buildout is
+the de facto standard for deploying Zope applications in a repeatable and easy
+way.  The description of what will be installed is defined by a buildout
+configuration file, buildout.cfg.
+
+Buildout files for 3.2 look slightly different to those for 3.0 and 3.1 – they
+don't need a custom plone installation step as buildout can now handle it
+directly:
+
+    [buildout]
+    # parts: note that the plone part is no longer necessary.
+    parts = 
+        zope
+        instance
+    
+    # find-links: only the new dist.plone.org URL is needed.
+    find-links = 
+        http://dist.plone.org/release/3.2
+    
+    # New: this will pick up version settings for all the components.
+    # Modify the "3.2rc1" to match the version you're seeking.
+    extends = http://dist.plone.org/release/3.2rc1/versions.cfg
+    versions = versions
+    
+    # eggs: Plone is now specified in the egg section. All the
+    # dependencies are automatically handled.
+    eggs =
+        Plone
+    
+    # zope part: Note the new fake-eggs settings. This is required
+    # for Zope dependencies to be resolved during buildout.
+    [zope]
+    recipe = plone.recipe.zope2install
+    url = http://www.zope.org/Products/Zope/2.10.6/Zope-2.10.6-final.tgz
+    fake-zope-eggs = true
+    additional-fake-eggs =
+        ZConfig
+        pytz
+    
+    # Everything else can usually be the same.
+    [instance]
+    recipe = plone.recipe.zope2instance
+    zope2-location = ${zope:location}
+    ...
+    
+If you have already modified your buildout.cfg file, for example to install new
+add-ons, remember to copy what you added to the eggs= and zcml= lines into the
+[instance] section. 
+
+If you've installed "old style" products you'll need to copy the productdistros
+section and add it to parts too.
+
+Custom buildout
+----------------
+To convert your existing custom buildout to Plone 3 is very easy.  The above
+example should be enough to make it clear what's needed, but in summary:
+
+1. Remove the [plone] section and its entry from parts
+
+2. Add the Plone egg to the eggs specification. Note that "Plone" is
+   capitalized.
+
+3. Copy the extends= and versions= directives from above into your buildout,
+   updating the version number to the target release.
+
+4. Modify the dist.plone.org line in find-links to match the version, as above.
+
+5. Add the two "fake-eggs" specifications above to the zope part specification.
+
+easy_install and virtualenv
+---------------------------
+If you wish to use the Python package installation tool easy_install, you may
+install Plone into your Python environment by running:
+
+    easy_install Plone
+
+Note that you may need to use easy_install-2.4 or specify the precise path of
+the Python 2.4.x that you're using with your Zope environment.
+
+Installing Plone via easy_install alone, though, may be hazardous to your
+system Python and your mental health, as various Python modules may require
+different versions of components. We highly recommend that you use virtualenv
+to create an isolated Python instance before proceeding.
+
+Version Migration
+=================
+
+No matter which technique you use to ugrade your Plone version, you'll need to
+use the portal_migrations tool in the Zope Management Interface to update your
+object database. This step is unchanged from past installations.
+
+ 
+
+
 Plone 3.1 - Apr, 2008
 =====================