[Checkins] SVN: zopetoolkit/doc/source/about/ Simplify the concepts by removing the core/extra distinction. This has led to too many questions and different interpretations inside the release team
Hanno Schlichting
hannosch at hannosch.eu
Sun Jun 13 16:47:21 EDT 2010
Log message for revision 113434:
Simplify the concepts by removing the core/extra distinction. This has led to too many questions and different interpretations inside the release team
Changed:
U zopetoolkit/doc/source/about/concepts.rst
D zopetoolkit/doc/source/about/coreextra.rst
U zopetoolkit/doc/source/about/index.rst
A zopetoolkit/doc/source/about/libraries.rst
-=-
Modified: zopetoolkit/doc/source/about/concepts.rst
===================================================================
--- zopetoolkit/doc/source/about/concepts.rst 2010-06-13 19:32:44 UTC (rev 113433)
+++ zopetoolkit/doc/source/about/concepts.rst 2010-06-13 20:47:21 UTC (rev 113434)
@@ -33,8 +33,8 @@
a CMS based on Zope 2 and the CMF.
Zope Toolkit
- the collection of Zope Toolkit core libraries. Neither includes the ZMI
- nor includes a particular way to create a project.
+ the collection of Zope Toolkit libraries. Neither includes the ZMI nor
+ includes a particular way to create a project.
Zope Toolkit release
a set of Zope Toolkit library versions that have been tested to work
Deleted: zopetoolkit/doc/source/about/coreextra.rst
===================================================================
--- zopetoolkit/doc/source/about/coreextra.rst 2010-06-13 19:32:44 UTC (rev 113433)
+++ zopetoolkit/doc/source/about/coreextra.rst 2010-06-13 20:47:21 UTC (rev 113434)
@@ -1,108 +0,0 @@
-Core and Extra concepts
-=======================
-
-The Zope Toolkit covers only some libraries in the wider Zope
-community and software repository. We introduce the concepts of *core*
-and *extra* to be able to distinguish between the two.
-
-Core libraries
---------------
-
-The Zope Toolkit is a set of libraries. These libraries are released
-independently, but typically build on each other.
-
-A library that at some point in time is considered to be part of the
-Zope Toolkit is called a "core library". The Zope Toolkit contains
-those libraries that are reused by a large number of projects, or that
-the Zope Toolkit developers want to promote to being more widely
-adopted. The Zope Toolkit developers especially favor inclusions of
-libraries that are used by other Zope projects.
-
-The set of libraries that is "core" can change over time depending on
-how these libraries evolve and are used. New libraries considered to
-be "core" can be added to the set, and existing libraries once
-considered "core" can be removed from the set. We should be careful
-though, as we cannot just drop libraries from the core without
-considerable thought. A library being in the core signals a level of
-commitment to this library.
-
-How do we determine which libraries are part of the Zope Toolkit,
-and which libraries are not? The set of Zope Toolkit libraries is
-not static; what is included continuously evolves. The project
-maintains a list of which libraries are considered core.
-
-The Zope Toolkit Release Team is the final arbiter of which libraries are in
-Zope Toolkit or not. It will generally make decisions according to these
-loose guidelines:
-
-* if it's used widely in our community by the different consumer
- platforms, it's likely core.
-
-* if it's used by only a single consumer platform, it's likely not
- core.
-
-* if only a few people use it, it's likely not core.
-
-* if it has a lot of people who contribute to it from our community,
- it's likely core.
-
-* if it's something we want to encourage more consumer platforms use,
- it's likely core.
-
-* if it contains specific user interface code, it's likely not
- core. If it contains code to help construct user interfaces however,
- it can be core.
-
-Libraries may have a different status in the core to convey extra
-information about them, such as deprecation status.
-
-Reasons to consider refactoring packages, making dependencies optional
-or removing a library from the ZTK are:
-
-* if a library contains specific user interface code this makes it a
- candidate for splitting it into a reusable non-UI part and a UI part
- that is outside of the toolkit. If a library is UI focused it makes
- it a candidate for removal from the toolkit.
-
-* if a library doesn't have narrative documentation and there is no
- commitment from maintainers to create such documentation. Naturally
- critical libraries with a lot of use won't just removed for this reason,
- but this should also be a good motivator to add documentation.
-
-* if a library depends on another library maintained in the Zope
- repository that is itself not in the core we should think about
- removing this dependency or making the dependency optional. Another
- possibility is to remove the library that has this dependency from
- the toolkit altogether, or to adopt the dependency itself into the
- toolkit.
-
-Extra libraries
----------------
-
-Surrounding the Zope Toolkit core libraries a large number of other
-libraries exist that are developed in association with the Zope
-Toolkit. These libraries integrate with the Zope Toolkit and make
-use of the Zope Toolkit. They are often maintained by developers
-that are also Zope Toolkit developers, and similar development
-practices are used.
-
-We will call these libraries "extra". Libraries in the extra group are
-sometimes candidates for inclusion in the core, or might be libraries
-formerly part of the core but still being maintained. In general some
-development philosophies and practices will be shared between the core
-and extra group of libraries.
-
-The Zope Toolkit release team *does* not control the development
-of the extra libraries in the repository, except where such a library
-is considered for adoption within the Zope Toolkit itself as a core
-library.
-
-Examples of "extra" libraries are the "hurry.query" library for
-constructing catalog queries, the "z3c.form" related libraries for
-form generation, and the "grokcore.component" library which contains a
-different way to configure components.
-
-Any library that is developed for integration with the Zope Toolkit
-in the Zope repository can be considered "extra"; "extra" is the set
-of libraries that is not in the Zope Toolkit but can work with it. By
-having an "extra" designation we can more easily discuss such libraries.
Modified: zopetoolkit/doc/source/about/index.rst
===================================================================
--- zopetoolkit/doc/source/about/index.rst 2010-06-13 19:32:44 UTC (rev 113433)
+++ zopetoolkit/doc/source/about/index.rst 2010-06-13 20:47:21 UTC (rev 113434)
@@ -5,5 +5,5 @@
:maxdepth: 1
history
- coreextra
+ libraries
concepts
Copied: zopetoolkit/doc/source/about/libraries.rst (from rev 113432, zopetoolkit/doc/source/about/coreextra.rst)
===================================================================
--- zopetoolkit/doc/source/about/libraries.rst (rev 0)
+++ zopetoolkit/doc/source/about/libraries.rst 2010-06-13 20:47:21 UTC (rev 113434)
@@ -0,0 +1,74 @@
+Toolkit libraries
+=================
+
+The Zope Toolkit consists of a set of libraries, which are commonly used by the
+three major Zope frameworks (BlueBream, Grok and Zope 2).
+
+Only a small subset of libraries from the Zope community are part of the
+Toolkit. The Toolkit is in principle not limited to libraries from Zope
+community.
+
+Toolkit libraries
+-----------------
+
+The Toolkit libraries are standalone libraries which have their own releases,
+bug trackers and in some cases active developer communities around them. The
+toolkit acts as an umbrella project to deal with aspects which span multiple
+of these libraries or have impacts on the major Zope frameworks.
+
+The set of libraries that is part of the Toolkit can change over time depending
+on how these libraries evolve and are used. New libraries considered for
+inclusion can be added to the set, and existing libraries no longer used can be
+removed from the set.
+
+So the set of Zope Toolkit libraries is not static; what is included
+continuously evolves. The project maintains a list of which libraries are part
+of the Toolkit.
+
+The Zope Toolkit Release Team is the final arbiter of which libraries are in
+Zope Toolkit or not. It will generally make decisions according to these
+loose guidelines:
+
+* if all three framework use it, it's likely included.
+
+* if it is in use in most applications build on top of all frameworks it's
+ likely included.
+
+* if it's used by only a single consumer platform, it's likely not included.
+
+* if only a few people use it, it's likely not included.
+
+* if it contains specific user interface code, it's likely not included. If it
+ contains code to help construct user interfaces however, it can be included.
+
+Libraries may have a different status in the Toolkit to convey extra information
+about them, such as deprecation status.
+
+Reasons to consider refactoring packages, making dependencies optional or
+removing a library from the ZTK are:
+
+* if a library contains specific user interface code this makes it a candidate
+ for splitting it into a reusable non-UI part and a UI part that is outside of
+ the toolkit. If a library is UI focused it makes it a candidate for removal
+ from the toolkit.
+
+* if a library doesn't have narrative documentation and there is no commitment
+ from maintainers to create such documentation. Naturally critical libraries
+ with a lot of use won't just be removed for this reason, but this should also
+ be a good motivator to add documentation.
+
+* if a library depends on another library maintained in the Zope repository that
+ is itself not in the Toolkit we should think about removing this dependency or
+ making the dependency optional. Another possibility is to remove the library
+ that has this dependency from the toolkit altogether, or to adopt the
+ dependency itself into the toolkit.
+
+Community libraries
+-------------------
+
+Surrounding the Zope Toolkit libraries a large number of other libraries exists.
+These libraries might integrate with the Zope Toolkit and might make use of the
+Zope Toolkit.
+
+The Zope Toolkit is not concerned with these community libraries and the release
+team *does not* control the development of these libraries.
More information about the checkins
mailing list