From 38d86990c8c8483f424333c56fd7d7fa337a7f08 Mon Sep 17 00:00:00 2001 From: richard Date: Tue, 7 Oct 2003 06:03:53 +0000 Subject: [PATCH] doc fixes git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@1899 57a73879-2fb5-44c3-a270-3262357dd7e2 --- CHANGES.txt | 2 +- doc/customizing.txt | 37 ++++++++++++++++++++++++++++++++++++- 2 files changed, 37 insertions(+), 2 deletions(-) diff --git a/CHANGES.txt b/CHANGES.txt index 1130e8b..82786ec 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -6,7 +6,7 @@ Feature: - support confirming registration by replying to the email (sf bug 763668) -2003-09-?? 0.6.2 +2003-09-29 0.6.2 Fixed: - cleaned up, clarified internal caching API in *dbm backends - stopped pyc writing to current directory! yay! (patch 800718 with changes) diff --git a/doc/customizing.txt b/doc/customizing.txt index f752e54..25b6628 100644 --- a/doc/customizing.txt +++ b/doc/customizing.txt @@ -2,7 +2,7 @@ Customising Roundup =================== -:Version: $Revision: 1.102 $ +:Version: $Revision: 1.103 $ .. This document borrows from the ZopeBook section on ZPT. The original is at: http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx @@ -301,6 +301,41 @@ of ``'setkey'``):: priority=Link("priority")) issue.setkey('title') + +What you can't do to the schema +------------------------------- + +You must never: + +**Remove the users class** + This class is the only *required* class in Roundup. Similarly, its + username, password and address properties must never be removed. + +**Change the type of a property** + Property types must *never* be changed - the database simply doesn't take + this kind of action into account. Note that you can't just remove a + property and re-add it as a new type either. If you wanted to make the + assignedto property a Multilink, you'd need to create a new property + assignedto_list and remove the old assignedto property. + + +What you can do to the schema +----------------------------- + +Your schema may be changed at any time before or after the tracker has been +initialised (or used). You may: + +**Add new properties to classes, or add whole new classes** + This is painless and easy to do - there are generally no repurcussions + from adding new information to a tracker's schema. + +**Remove properties** + Removing properties is a little more tricky - you need to make sure that + the property is no longer used in the `web interface`_ *or* by the + detectors_. + + + Classes and Properties - creating a new information store --------------------------------------------------------- -- 2.30.2