[CMF-checkins] CVS: CMF - ISSUES.txt:1.1 HISTORY.txt:1.2 README.txt:1.2

tseaver@digiciool.com tseaver@digiciool.com
Mon, 12 Mar 2001 13:36:24 -0500 (EST)


Update of /cvs-repository/CMF
In directory korak:/tmp/cvs-serv1447

Modified Files:
	HISTORY.txt README.txt 
Added Files:
	ISSUES.txt 
Log Message:


* Add packaging files.



--- Added File ISSUES.txt in package CMF ---
CMF 1.0beta:  Known Issues

  Overview

    This document describes known issues with the beta release of
    the Content Management Framework (CMF), version 1.0.
    For more information on the CMF, please see the "website",
       http://cmf.zope.org.

  Package and Module Name Changes

    In order to improve the future maintainability of the CMF,
    and as part of the "rebranding" of the product from "Portal
    Toolkit" to "Content Management Framework", we have moved the
    code base to a new set of packages:

      'CMF' -- the "top-level" package, replaces 'ZopePTK'.

      'CMFCore' -- provides essential interfaces and services of
        the framework.  All CMF sites will use this package;
        most will not replace the services it provides.  Most
        modules in this package came from the old 'PTKBase'
        package.

      'CMFDefault' -- provides a set of content objects and
        services which allow construction of a useful CMF site
        "out of the box";  while many sites will use these
        objects directly, many will extend or replace them.  Most
        modules in this package came from the old 'PTKDemo'
        package.

      'CMFTopic' -- provides a new, "add-in" content object, the
        Topic.  Topics represent "canned" catalog queries, and
        are useful for presenting "logical collections" of
        content, based on common metadata.

  CVS Changes

    Until this release, the "canonical" CVS repository for the
    PTK/CMF has been on the public CVS mirror, cvs.zope.org.
    This placement has been somewhat problematic:  because all
    the *other* CVS code is replicated from Digital Creations'
    internal CVS repository, tags and branches created on PTK/CMF
    files tended to get "forgotten" during the synchronization.
    Going forward, we will keep the CMF repository alongside the
    main Zope repository, and replicate it to the public mirror.

  Migrating Existing PTK Sites

    The changes to package and module names (mentioned above)
    have significant impacts for existing PTK sites:  instances
    created from classes defined in 'PTKBase' or 'PTKDemo' will
    need to be "re-seated" as instances of their cognates in
    'CMFCore' or 'CMFDefault'.  In the past, we have arranged to
    do such reseating "in place";  for this change, however, we
    plan not to require a "copying" migration, in order to remove
    the need to maintain the backward-compatibility cruft
    required by the in-place strategy.
    
    We will provide a script shortly to aid this migration (in
    fact, it will be the script which we use to migrate the
    "dogbowl" site this week.

--- Updated File HISTORY.txt in package CMF --
--- HISTORY.txt	2001/02/23 14:24:07	1.1
+++ HISTORY.txt	2001/03/12 18:35:53	1.2
@@ -1,4 +1,27 @@
-1.0 beta (2001/02/16)
+1.0 beta (2001/03/05)
+
+ * Migrated from old PTK repository on cvs.zope.org.
+
+ * Changed package and module names:  'PTKBase' has become
+   (mostly) 'CMFCore';  'PTKDemo', 'CMFDefault'.
+
+ * Added package 'CMFTopic', which provides a new content type,
+   'Topic';  topics are "logical" folders, which aggregate
+   content based on catalog searches against metadata.
+ 
+ * Revised discussion mechanism to store discussion with its
+   underlying content (rather than in members' "Correspondence"
+   folders).
+
+ * Mad the membership system agnostic to the kind of user
+   folder, including whether it is found in the portal or not.
+
+ * "Skinned" the portal UI and all the content objects,
+   enabling portal managers to replace it "piecemeal", safely.
+
+ * Implemented local type registration, allowing portal
+   managers to configure and extend the types addable in the
+   portal.
 
  * Add 'PortalFolder.allowedContentTypes' and supporting machinery
    in type info objects, to permit configuration of the content

--- Updated File README.txt in package CMF --
--- README.txt	2001/02/23 04:08:54	1.1
+++ README.txt	2001/03/12 18:35:53	1.2
@@ -1,7 +1,60 @@
 Zope Content Management Framework (CMF) README
 
- Relase Notes
+  What is the CMF?
 
-  1.0 beta 1 (2001/02/28)
+    The Zope Content Management Framework provides a set of
+    services and content objects useful for building highly
+    dynamic, content-oriented portal sites.  As packaged, the
+    CMF generates a site much like the Zope.org site.  The CMF is
+    intended to be easily customizable, in terms of both the
+    types of content used and the policies and services it
+    provides.
 
-   * Migrated from old PTK repository on cvs.zope.org.
+  Resources
+
+    * The CMF "dogbowl" site, http://cmf.zope.org.
+
+    * The mailing list, zope-ptk@zope.org.  List information and
+      online signup are available at:
+      http://lists.zope.org/mailman/listinfo/zope-ptk.  Archives
+      of the list are at: http://lists.zope.org/pipermail/zope-ptk.
+
+  Known Issues
+
+    Please see the separate "issues list":ISSUES.txt.
+
+  Installation
+
+    Requirements
+
+      - Zope v. 2.3.1b1 or later OR
+      
+      - Zope 2.3.0 with Jeffrey Shell's "security info patch",
+          http://cmf.zope.org/Members/jshell/security_info.patch 
+
+    Assumptions
+
+      - New installation
+
+      - Zope configured using INSTANCE_HOME, '/var/zope', and
+        SOFTWARE_HOME, '/usr/local/zope/Zope-2.3.1b1'.
+
+    Procedure
+
+      1. Unpack the 'CMF-1.0beta.tar.gz' tarball into a working
+         directory.  For instance:
+
+           $ cd /usr/local/zope
+           $ tar xzf /tmp/CMF-1.0beta.tar.gz
+
+      2. Link (or copy/move) the three CMF packages into
+         '$INSTANCE_HOME/Products'.  For instance:
+
+           $ cd /var/zope/Products
+           $ ln -s /usr/local/zope/CMF-1.0beta/* .
+ 
+      3. Restart Zope;  verify that the three CMF products loaded
+         property, by examining them in 'Control_Panel/Product'.
+
+      4. Create a 'CMF Site' object.  Join, and begin adding
+         content.  Enjoy!