Skip to content

Commit a6fb733

Browse files
author
Richard Jones
committed
merge from HEAD
1 parent 4e01dfa commit a6fb733

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

doc/customizing.txt

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Customising Roundup
33
===================
44

5-
:Version: $Revision: 1.93.2.3 $
5+
:Version: $Revision: 1.93.2.4 $
66

77
.. This document borrows from the ZopeBook section on ZPT. The original is at:
88
http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -301,6 +301,41 @@ of ``'setkey'``)::
301301
priority=Link("priority"))
302302
issue.setkey('title')
303303

304+
305+
What you can't do to the schema
306+
-------------------------------
307+
308+
You must never:
309+
310+
**Remove the users class**
311+
This class is the only *required* class in Roundup. Similarly, its
312+
username, password and address properties must never be removed.
313+
314+
**Change the type of a property**
315+
Property types must *never* be changed - the database simply doesn't take
316+
this kind of action into account. Note that you can't just remove a
317+
property and re-add it as a new type either. If you wanted to make the
318+
assignedto property a Multilink, you'd need to create a new property
319+
assignedto_list and remove the old assignedto property.
320+
321+
322+
What you can do to the schema
323+
-----------------------------
324+
325+
Your schema may be changed at any time before or after the tracker has been
326+
initialised (or used). You may:
327+
328+
**Add new properties to classes, or add whole new classes**
329+
This is painless and easy to do - there are generally no repurcussions
330+
from adding new information to a tracker's schema.
331+
332+
**Remove properties**
333+
Removing properties is a little more tricky - you need to make sure that
334+
the property is no longer used in the `web interface`_ *or* by the
335+
detectors_.
336+
337+
338+
304339
Classes and Properties - creating a new information store
305340
---------------------------------------------------------
306341

0 commit comments

Comments
 (0)