Commit 84014aab authored by Hanno Schlichting's avatar Hanno Schlichting

Update maintenance and virtualenv creation docs.

parent c4961738
...@@ -7,6 +7,7 @@ recursive-include docs * ...@@ -7,6 +7,7 @@ recursive-include docs *
recursive-include src * recursive-include src *
prune docs/.build prune docs/.build
prune docs/_build
global-exclude *.dll global-exclude *.dll
global-exclude *.pyc global-exclude *.pyc
......
...@@ -20,12 +20,14 @@ Create a Virtual Environment ...@@ -20,12 +20,14 @@ Create a Virtual Environment
Install the Zope2 Software Packages Install the Zope2 Software Packages
----------------------------------- -----------------------------------
To install a specific version of Zope, use a tag specific URL instead of
master as suggested in the below example:
.. code-block:: sh .. code-block:: sh
$ bin/pip install \ $ bin/pip install \
--trusted-host download.zope.org \ -r https://raw.githubusercontent.com/zopefoundation/Zope/master/requirements.txt
--index http://download.zope.org/Zope2/index/2.13.22/ Zope2 Obtaining Zope2
Collecting Zope2
... ...
Successfully installed ... Successfully installed ...
...@@ -40,14 +42,7 @@ Zope server process. The instance home is created using the ...@@ -40,14 +42,7 @@ Zope server process. The instance home is created using the
.. code-block:: sh .. code-block:: sh
$ bin/mkzopeinstance $ bin/mkzopeinstance -d .
You can specify the Python interpreter to use for the instance
explicitly:
.. code-block:: sh
$ bin/mkzopeinstance --python=bin/python
You will be asked to provide a user name and password for an You will be asked to provide a user name and password for an
administrator's account during ``mkzopeinstance``. To see the available administrator's account during ``mkzopeinstance``. To see the available
...@@ -57,17 +52,9 @@ command-line options, run the script with the ``--help`` option: ...@@ -57,17 +52,9 @@ command-line options, run the script with the ``--help`` option:
$ bin/mkzopeinstance --help $ bin/mkzopeinstance --help
Using the ``virtualenv`` as the Zope Instance The `-d .` specifies the directory to create the instance home in.
--------------------------------------------- If you follow the example and choose the current directory, you'll
find the instances files in the subdirectories of the ``virtualenv``:
You can choose to use the ``virtualenv`` as your Zope instance:
.. code-block:: sh
$ bin/mkzopeinstance -d .
In this case, the instance files will be located in the
subdirectories of the ``virtualenv``:
- ``etc/`` will hold the configuration files. - ``etc/`` will hold the configuration files.
- ``log/`` will hold the log files. - ``log/`` will hold the log files.
......
...@@ -5,22 +5,6 @@ This document assumes you have installed Zope into a ``virtualenv`` (see ...@@ -5,22 +5,6 @@ This document assumes you have installed Zope into a ``virtualenv`` (see
:doc:`INSTALL-virtualenv`). :doc:`INSTALL-virtualenv`).
Install the Supporting Software
-------------------------------
To run as a WSGI application, you need to install some additional software.
.. code-block:: sh
$ bin/pip install \
--trusted-host download.zope.org \
--index http://download.zope.org/Zope2/index/2.13.22/ \
repoze.who repoze.tm2 repoze.retry Paste PasteDeploy PasteScript
Collecting repoze.who
...
Successfully installed Paste-1.7.5.1 PasteDeploy-1.3.4 PasteScript-1.7.5 repoze.retry-1.2 repoze.tm2-1.0 repoze.who-2.0
Update the Zope Application Configuration Update the Zope Application Configuration
----------------------------------------- -----------------------------------------
......
Maintenance information Maintenance information
======================== =======================
.. note:: .. note::
...@@ -21,36 +21,39 @@ The following persons have access to the ``Zope2`` package on PyPI ...@@ -21,36 +21,39 @@ The following persons have access to the ``Zope2`` package on PyPI
Steps for creating a new Zope release Steps for creating a new Zope release
+++++++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++++++
- check the versions.cfg file for outdated or updated - Check the versions.cfg file for outdated or updated
packages and update version information where necessary packages and update version information where necessary.
- update version information: - Update version information:
- setup.py (remove dev postfix) - setup.py (remove dev postfix)
- versions.cfg (pin Zope2) - versions-prod.cfg (pin Zope2)
- requirements.txt (pin Zope2)
- update docs/CHANGES.rst - The requirements.txt is autogenerated on each bin/buildout run.
So instead of manually adjusting it, you can update versions-prod.cfg
and then run bin/buildout once.
- run all tests:: - Update docs/CHANGES.rst with a release date.
- Run all tests::
bin/alltests bin/alltests
- tag the release - Tag the release.
- upload the tagged release to PyPI:: - Upload the tagged release to PyPI::
python2.7 setup.py egg_info -RDb '' sdist --formats=zip register upload python2.7 setup.py egg_info -RDb '' sdist --formats=zip register upload
- update version information: - Update version information:
- setup.py (bump version number, add dev postfix) - setup.py (bump version number, add dev postfix)
- versions.cfg (remove Zope2 pin) - versions-prod.cfg (remove Zope2 pin)
- requirements.txt (replace Zope2 pin by git reference, either manually
or run bin/buildout).
- check the visible releases on readthedocs.org at (should default to - Check the visible releases on readthedocs.org at (should default to
showing the active branches):: showing the active branches)::
https://readthedocs.org/dashboard/zope/versions/ https://readthedocs.org/dashboard/zope/versions/
- update the status of all bugs associated with the released milestone::
https://launchpad.net/zope2/+milestone/2.13.x
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment