- Updated Zope documentation sources for Zope 5

zopefoundation · Nov 28, 2019 · c7dfe13 · c7dfe13
1 parent 2ada72e
commit c7dfe13
Show file tree

Hide file tree

Showing 15 changed files with 414 additions and 422 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -9,6 +9,9 @@ https://github.com/zopefoundation/Zope/blob/4.x/CHANGES.rst
 5.0a1 (unreleased)
 ------------------
 
+- Updated Zope documentation sources for Zope 5
+  (`#659 <https://github.com/zopefoundation/Zope/issues/659>`_)
+
 - The method ``unrestrictedTraverse`` raises an error when
   the argument ``path`` is not something it can work with
   (`#674 <https://github.com/zopefoundation/Zope/issues/674>`_)

diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst
@@ -14,9 +14,8 @@ In order to install Zope, you must have the following prerequisites
 available:
 
 - A supported version of Python, including the development support if
-  installed from system-level packages.  Supported versions include:
-
-  * 3.5 up to 3.8
+  installed from system-level packages.  Supported versions include
+  **3.5** up to **3.8**.
 
 - Zope needs the Python ``zlib`` module to be importable.  If you are
   building your own Python from source, please be sure that you have the
@@ -126,10 +125,9 @@ options, please see the
 
     [zopeinstance]
     recipe = plone.recipe.zope2instance
-    eggs =
-        Products.TemporaryFolder
     user = admin:adminpassword
     http-address = 8080
+    zodb-temporary-storage = off
 
 One feature this kind of installation offers is the easy integration of WSGI
 servers other than the built-in ``waitress``. You can specify a file path to a
@@ -143,10 +141,10 @@ include the WSGI server software egg in the ``eggs`` specification:
     [zopeinstance]
     recipe = plone.recipe.zope2instance
     eggs =
-        Products.TemporaryFolder
         gunicorn
     user = admin:adminpassword
     http-address = 8080
+    zodb-temporary-storage = off
     wsgi = /path/to/zope.ini
 
 Installing Zope with ``pip``

diff --git a/docs/conf.py b/docs/conf.py
@@ -24,9 +24,9 @@
 author = 'The Zope developer community'
 
 # The short X.Y version
-version = '4.1'
+version = '5.0'
 # The full version, including alpha/beta/rc tags
-release = '4.1'
+release = '5.0'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/index.rst b/docs/index.rst
@@ -5,10 +5,10 @@ This is the official home for all Zope documentation.
 .. toctree::
    :maxdepth: 2
 
-   zope4/index
+   news
    INSTALL
+   migrations/index
    operation
-   wsgi
    maintenance
    changes
    zopebook/index

diff --git a/docs/migrations/index.rst b/docs/migrations/index.rst
@@ -0,0 +1,9 @@
+Migrating between Zope versions
+===============================
+
+These documents outline migration steps that may be required when upgrading
+Zope.
+
+.. toctree::
+
+   zope4/index
diff --git a/docs/zope4/migration/code.rst → docs/migrations/zope4/code.rst b/docs/zope4/migration/code.rst → docs/migrations/zope4/code.rst
diff --git a/docs/zope4/migration/content.rst → docs/migrations/zope4/content.rst b/docs/zope4/migration/content.rst → docs/migrations/zope4/content.rst
diff --git a/docs/zope4/migration/index.rst → docs/migrations/zope4/index.rst b/docs/zope4/migration/index.rst → docs/migrations/zope4/index.rst
@@ -1,7 +1,7 @@
 .. _zope4migration:
 
-Migrating to Zope 4
-===================
+Migrating from Zope 2 to Zope 4 or 5
+====================================
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/zope4/migration/removed.rst → docs/migrations/zope4/removed.rst b/docs/zope4/migration/removed.rst → docs/migrations/zope4/removed.rst
diff --git a/docs/zope4/migration/zodb.rst → docs/migrations/zope4/zodb.rst b/docs/zope4/migration/zodb.rst → docs/migrations/zope4/zodb.rst
diff --git a/docs/zope4/news.rst → docs/news.rst b/docs/zope4/news.rst → docs/news.rst
@@ -1,19 +1,41 @@
-What's new in Zope 4
-====================
-The article explains the new high-level features and changes found in this
-version of Zope.
+What's new in Zope
+==================
+The article explains the new high-level features and changes found in Zope.
+
+You can have a look at the `detailed change log <./changes.html>`_ to learn
+about all minor new features and bugs being solved in the latest release.
+
+.. attention::
+
+    If you are upgrading from Zope 2, make sure you study the
+    :ref:`zope4migration` documentation
 
-You can have a look at the `detailed change log <../changes.html>`_ to learn
-about all minor new features and bugs being solved in this release. When you
-are ready to migrate, make sure you study the :ref:`zope4migration`
-documentation.
 
 .. contents::
    :local:
 
 
+What's new in Zope 5
+--------------------
+
+Dropped support for Python 2
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Zope 5 supports Python 3 only, versions 3.5 up through 3.8. All support code
+and special casing for Python 2, including the use of the ``six`` package, have
+been removed.
+
+Dropped support for ``ZServer``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+As ``ZServer`` only supports Python 2, its integration has been removed. Only
+`WSGI` is now supported for web service.
+
+
+
+What's new in Zope 4
+--------------------
+
 Restored sane version numbering
--------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Version numbers for Zope have been confusing in the past. The original Zope
 project iterated through version one to two up to version 2.13. In parallel
 a separate project was launched using the name Zope 3. Zope 3 wasn't a new
@@ -28,19 +50,18 @@ found in this release.
 
 
 Extended Python version support
--------------------------------
-Zope 5 supports Python 3.5 up to Python 3.8.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Zope 4 supports Python 2.7 and Python 3 versions 3.5 up to 3.8.
 
 The Python 3 support currently covers the core dependencies shipped
 with Zope and is limited to the new WSGI based publisher.
 
 Migrating an existing ZODB to Python 3 is not an automated process. You have
-to update to Zope 4 first, see
-`Zope 4 migration <https://zope.readthedocs.io/en/4.x/zope4/migration/index.html>`_.
+to update to Zope 4 first, see :ref:`zope4migration`.
 
 
 WSGI as the new default server type
------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Zope 2.13 first gained support for running Zope as a WSGI application,
 using any WSGI capable web server instead of the built-in ZServer.
 
@@ -106,7 +127,7 @@ based publisher.
 
 
 View component Acquisition changes
-----------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 In Zope 2.12 Zope Toolkit view components changed and stopped inheriting
 from Acquisition base classes, as Acquisition got aware of `__parent__`
 pointers, which meant that ``aq_parent(view)`` worked, without the view
@@ -119,7 +140,7 @@ view page template files or viewlets.
 
 
 Page Templates now rendered by Chameleon
-----------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Chameleon is an alternative implementation of the page template language
 supporting additional features and impressive template rendering speed.
 
@@ -138,15 +159,15 @@ manually.
 
 
 Lower memory consumption at runtime
------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Zope 4 depends on a new DateTime release. The new release has been optimized
 for better memory use. Applications using a lot of DateTime values like the
 Plone CMS have seen total memory usage to decrease by 10% to 20% for medium
 to large deployments.
 
 
 Simplified encoding configuration
----------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 As it is reasonable to have one unified encoding in ZMI and frontend, support
 for ``management_page_charset`` (as property of a folder) has been removed.
 ``default-zpublisher-encoding`` in `zope.conf` is the only place where to
@@ -155,7 +176,7 @@ Templates handle encoding and decoding of text.
 
 
 Restyled Zope Management Interface (ZMI)
-----------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 The ZMI (Zope Management Interface) is now styled with Bootstrap.
 See :ref:`ZMI-label` for details how to adapt Zope add-on packages to the new
 styling.