[Checkins] SVN: zopetoolkit/doc/source/ Turn open issues into blueprints, introduce proposal section.
Christian Theune
ct at gocept.com
Tue Sep 15 05:14:35 EDT 2009
Log message for revision 104018:
Turn open issues into blueprints, introduce proposal section.
Add my mail address for direct contact.
Simplify some document titles and re-order indices for easier reading.
Update bug tracking documentation.
Changed:
U zopetoolkit/doc/source/index.rst
U zopetoolkit/doc/source/process/bug-tracking.rst
A zopetoolkit/doc/source/process/buildbots.rst
U zopetoolkit/doc/source/process/index.rst
U zopetoolkit/doc/source/process/maintaining-software.rst
U zopetoolkit/doc/source/process/proposals.rst
U zopetoolkit/doc/source/process/python-versions.rst
U zopetoolkit/doc/source/process/releasing-software.rst
U zopetoolkit/doc/source/process/repository.rst
D zopetoolkit/doc/source/process/tools.rst
A zopetoolkit/doc/source/proposals/
A zopetoolkit/doc/source/proposals/index.rst
U zopetoolkit/doc/source/steeringgroup/decisionmaking.rst
U zopetoolkit/doc/source/steeringgroup/decisions.rst
U zopetoolkit/doc/source/steeringgroup/index.rst
U zopetoolkit/doc/source/steeringgroup/members.rst
D zopetoolkit/doc/source/steeringgroup/openissues.rst
-=-
Modified: zopetoolkit/doc/source/index.rst
===================================================================
--- zopetoolkit/doc/source/index.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/index.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -32,6 +32,7 @@
about/index
releases/index
+ proposals/index
process/index
codingstyle/index
steeringgroup/index
Modified: zopetoolkit/doc/source/process/bug-tracking.rst
===================================================================
--- zopetoolkit/doc/source/process/bug-tracking.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/process/bug-tracking.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -1,17 +1,23 @@
Bug tracking
============
-Zope 3 bugs are tracked using Launchpad's bugtracker at
-https://bugs.launchpad.net/zope3.
+ZTK bugs are tracked in individual projects (one per package) using Launchpad's bugtracker at
+https://bugs.launchpad.net/zopetoolkit.
-Bugs from the previous bugtracker (which lived somewhere below
-http://www.zope.org/Collectors) have aliases of the form zope3dev-NNN where NNN
-is the old bug number, so they can be retrieved by searching for these on
-Launchpad.
-
``XXX``, ``FIXME`` or ``TODO`` comments in the source code are not
considered bugs and therefore cannot block releases. Consider adding a
bug in addition to the comment. If something is really broken and you
want to indicate it with ``XXX``, consider instead not checking this
-into the trunk of a project at all.
+into the trunk of a project but into a separate working branch.
+Historical bugs
+---------------
+
+Historically, bugs have been tracked with the Zope 3 project
+(https://bugs.launchpad.net/zope3).
+
+Even longer ago, Zope 3 used its own bugtracker (which lived at
+http://www.zope.org/Collectors). Those were imported into the Launchpad bug
+database and have aliases of the form "zope3dev-NNN" where "NNN" is the old
+bug number, so they can be retrieved by searching for these on Launchpad.
+
Copied: zopetoolkit/doc/source/process/buildbots.rst (from rev 103915, zopetoolkit/doc/source/process/tools.rst)
===================================================================
--- zopetoolkit/doc/source/process/buildbots.rst (rev 0)
+++ zopetoolkit/doc/source/process/buildbots.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -0,0 +1,15 @@
+Buildbots
+=========
+
+http://dev.thehealthagency.com/buildbot/
+ Tests the trunks of ZTK, grok and zc.buildout (run by TheHealthAgency)
+
+http://zope3.pov.lt/buildbot/
+ Tests the KGS for Zope 3.4 (run by POV)
+
+http://zope3.afpy.org/buildbot/
+ Tests the Zope 3.4 and Zope 3.5 (run by AFPY)
+
+http://zope.buildbot.securactive.org/
+ Tests the trunk of `zope.release` (run by SecurActive SA)
+
Property changes on: zopetoolkit/doc/source/process/buildbots.rst
___________________________________________________________________
Added: svn:mergeinfo
+
Modified: zopetoolkit/doc/source/process/index.rst
===================================================================
--- zopetoolkit/doc/source/process/index.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/process/index.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -13,12 +13,12 @@
.. toctree::
:maxdepth: 1
+ bug-tracking
+ buildbots
+ python-versions
releasing-software
- python-versions
+ proposals
maintaining-software
repository
- bug-tracking
communication
- proposals
- tools
old-references
Modified: zopetoolkit/doc/source/process/maintaining-software.rst
===================================================================
--- zopetoolkit/doc/source/process/maintaining-software.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/process/maintaining-software.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -1,5 +1,5 @@
-Maintaining software in the Zope software repository
-====================================================
+Maintaining software
+====================
:Author: Philipp von Weitershausen <philipp at weitershausen.de>
:Status: Draft
Modified: zopetoolkit/doc/source/process/proposals.rst
===================================================================
--- zopetoolkit/doc/source/process/proposals.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/process/proposals.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -1,13 +1,20 @@
Proposals for new functionality
===============================
-Proposals are a semi-formal way to write down our ideas for new
-functionality and larger changes to the code base. They are discussed
-and then get accepted (so somebody might be free to implement them) or
-denied. We keep them available for historical reference.
+Proposals are a semi-formal way to write down our ideas for new functionality
+and larger changes to the code base and process. They are discussed and then
+get accepted or denied by the developers. We keep them available for
+historical reference.
-The first place we gathered proposals was our wiki on the proposals
-page: http://wiki.zope.org/zope3/Proposals
+Proposals are tracked in Launchpad: https://blueprints.launchpad.net/zopetoolkit/
-At some point we also started tracking their status in Launchpad using
-the blueprint system: https://blueprints.launchpad.net/zope3/
+Note: General proposals for the toolkit need to be registered within the
+"zopetoolkit-project" on Launchpad.
+
+Detailed specifications of proposals are placed in the developer documentation
+which can be edited by checking out
+svn+ssh://svn.zope.org/repos/main/zopetoolkit/doc and adding a separate page
+in the "Proposals" section.
+
+You should point the blueprint's external URL to the corresponding page
+generated on http://docs.zope.org/zopetoolkit.
Modified: zopetoolkit/doc/source/process/python-versions.rst
===================================================================
--- zopetoolkit/doc/source/process/python-versions.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/process/python-versions.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -1,9 +1,6 @@
-Python versions supported by the Zope Toolkit
-=============================================
+Supported versions of Python
+============================
-:Author: Martijn Faassen <faassen at startifact.com>
-:Status: Current
-
The Zope Toolkit currently supports the following versions of Python:
* Python 2.4
@@ -14,4 +11,3 @@
This means that no features beyond Python 2.4 should be used in any
library that is part of the Zope Toolkit.
-
Modified: zopetoolkit/doc/source/process/releasing-software.rst
===================================================================
--- zopetoolkit/doc/source/process/releasing-software.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/process/releasing-software.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -3,9 +3,9 @@
When releasing software, the following steps should be taken:
-1. Make sure all automated tests of the package pass. If the package
- is tracking bugs on launchpad, make sure there are no release
- critical bugs for that release.
+1. Make sure all automated tests of the package pass. The ZTK packages track
+ bugs on Launchpad. Make sure there are no release-critical bugs left for
+ the package.
2. Fill in the release date in ``CHANGES.txt``. Make sure the
changelog is complete.
Modified: zopetoolkit/doc/source/process/repository.rst
===================================================================
--- zopetoolkit/doc/source/process/repository.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/process/repository.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -1,8 +1,8 @@
-Accessing the Zope Framework repository
-=======================================
+Accessing the Subversion repository
+===================================
-The Zope Framework code is maintained via Subversion in the official
-Zope repository at svn://svn.zope.org/repos/main.
+The Zope Toolkit code is maintained via Subversion in the official Zope
+repository at svn://svn.zope.org/repos/main.
Code browsing
-------------
Deleted: zopetoolkit/doc/source/process/tools.rst
===================================================================
--- zopetoolkit/doc/source/process/tools.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/process/tools.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -1,18 +0,0 @@
-Tools
-=====
-
-
-Buildbots
-~~~~~~~~~
-
-http://zope3.pov.lt/buildbot/
- Tests the KGS for Zope 3.4 (run by POV)
-
-http://zope3.afpy.org/buildbot/
- Tests the Zope 3.4 and Zope 3.5 (run by AFPY)
-
-http://zope.buildbot.securactive.org/
- Tests the trunk of `zope.release` (run by SecurActive SA)
-
-http://dev.thehealthagency.com/buildbot/
- Tests the trunks of ZTK, grok and zc.buildout (run by TheHealthAgency)
Added: zopetoolkit/doc/source/proposals/index.rst
===================================================================
--- zopetoolkit/doc/source/proposals/index.rst (rev 0)
+++ zopetoolkit/doc/source/proposals/index.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -0,0 +1,5 @@
+Proposals
+=========
+
+.. toctree::
+ :maxdepth: 1
Modified: zopetoolkit/doc/source/steeringgroup/decisionmaking.rst
===================================================================
--- zopetoolkit/doc/source/steeringgroup/decisionmaking.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/steeringgroup/decisionmaking.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -1,5 +1,5 @@
-How the Zope Toolkit Steering Group can help you
-================================================
+How we can help you
+===================
If you want to make some change to the Zope Toolkit, start a thread
on zope-dev about it. The Steering Group is watching.
Modified: zopetoolkit/doc/source/steeringgroup/decisions.rst
===================================================================
--- zopetoolkit/doc/source/steeringgroup/decisions.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/steeringgroup/decisions.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -1,5 +1,5 @@
-Decisions of the Zope Toolkit Steering Group
-============================================
+Decisions
+=========
This is a temporary place to note decisions. The idea is to later
integrate them into the Zope Toolkit documentation, but we need a
Modified: zopetoolkit/doc/source/steeringgroup/index.rst
===================================================================
--- zopetoolkit/doc/source/steeringgroup/index.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/steeringgroup/index.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -12,8 +12,7 @@
.. toctree::
:maxdepth: 1
- decisions
- openissues
decisionmaking
+ decisions
members
Modified: zopetoolkit/doc/source/steeringgroup/members.rst
===================================================================
--- zopetoolkit/doc/source/steeringgroup/members.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/steeringgroup/members.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -1,11 +1,10 @@
-Membership of the Zope Toolkit Steering Group
-=============================================
+Members
+=======
* Martijn Faassen
* Stephan Richter
-* Christian Theune
+* Christian Theune <ct at gocept.com>
* Jim Fulton
-
Deleted: zopetoolkit/doc/source/steeringgroup/openissues.rst
===================================================================
--- zopetoolkit/doc/source/steeringgroup/openissues.rst 2009-09-15 09:11:11 UTC (rev 104017)
+++ zopetoolkit/doc/source/steeringgroup/openissues.rst 2009-09-15 09:14:35 UTC (rev 104018)
@@ -1,90 +0,0 @@
-Open Issues
-===========
-
-These are issues that are currently under discussion and on which the
-steering group will want to make a decision soon.
-
-* Do we want to deprecate the deprecation system? See
- http://mail.zope.org/pipermail/zope-dev/2009-March/035130.html
-
-* Python 3 may collide with __annotations__. In the last years Python
- clarified that the language claims __*__ attributes so we need to figure out
- how to deal with the occurances where we use those attributes (__name__,
- __parent__)
- http://mail.zope.org/pipermail/zope-dev/2009-March/035237.html
-
-* Produce a list of `the toolkit packages`. See
- http://mail.zope.org/pipermail/zope-dev/2009-March/035078.html.
-
-* Document usage of compattest. `compattest` is being mentioned for
- test runs and should be documented as an (optional) part of the toolkit
- development.
-
-* Support using ``setup.py test``? See
- http://mail.zope.org/pipermail/zope-dev/2009-March/035240.html
-
-* We should investigate the possible role of WebOb in the Zope
- Toolkit. See http://mail.zope.org/pipermail/zope-dev/2009-March/034870.html
-
-* When can we give up Python 2.4 compatibility for new releases of
- packages? The following decision didn't please everybody:
-
- * New feature releases of packages in the Zope Toolkit should be
- compatible with Python 2.5 (and 2.6, preferably). Python 2.4
- compatibility is not required.
-
- The following low-level packages are exceptions that do still need
- Python 2.4 compatibility:
-
- * zope.interface, zope.schema, zope.component, zope.event,
- zope.i18nmessageid
-
-* publisher and traversal simplification: Shane Hathaway's WSGI
- pipeline work, Jim's new bobo should be points to explore.
-
-* reusable components that include a UI. Might be separated into two
- components (API and UI), or even three (API, web service and
- UI). Example use cases are user management and tagging. Explore
- Pinax for more examples. The irony and great potential of the ZTK
- right now is that we *have* a component story that works pretty well
- so we *should* be able to do great flexible UI components, but we
- don't have a good story for this at all.
-
-* dependency refactoring: this is an ongoing process to try to flatten
- the dependency structure between packages and allow greater reusability
- of our code, and reduce the amount of code that is needed in a minimal
- setup (less to understand, and less startup time).
-
-* startup time: reduce the startup time of ZTK applications so that
- the paster auto-restart becomes more tolerable.
-
-* We need a process to implement new functionality/features within the ZTK.
- There seems to be some tendency to implement new functionality in each
- framework/project without a backchannel to share results on a common basis.
-
-* Provide a dash-board for getting an overview about all libraries of the ZTK
- with information about: bugs (open, new, ...), test status, XXX comment
- status, dependency graphs.
-
-* Write document on optional integration, see ML article by Jim Fulton,
- "Optional integration need not introduce dependences"
-
-* Write document on rules concerning extra requires and test_require for
- tests. Quoting Jim:
-
- I'd like us to say something along the lines of:
-
- "If your tests have additional dependencies, define "test" extra
- with these dependencies. Also define tests_require and test_suite
- so that your package supports the test command."
-
- (Not verbatim and we should give examples.)
-
- Note I used to object to tests_require because the information
- wasn't available after installation. I still do, but I've started
- using it anyway. Tres wrote a plugin to fix this (thanks Tres),
- but I think it's easier just to define tests_require (and test
- suite) along with tests_require.
-
- Letting people run tests via the setup command is a lot better than
- trying to tell them how to use a buildout.
More information about the checkins
mailing list