From 2176cf7ec892e74da568be0b1ea4e4db1db9e195 Mon Sep 17 00:00:00 2001 From: richard Date: Thu, 15 Aug 2002 00:39:51 +0000 Subject: [PATCH] doc updates git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@951 57a73879-2fb5-44c3-a270-3262357dd7e2 --- doc/customizing.txt | 16 +++++++++++----- doc/developers.txt | 20 +++++++++++++++++--- doc/upgrading.txt | 1 + 3 files changed, 29 insertions(+), 8 deletions(-) diff --git a/doc/customizing.txt b/doc/customizing.txt index a2ad95e..d2e466b 100644 --- a/doc/customizing.txt +++ b/doc/customizing.txt @@ -2,7 +2,7 @@ Customising Roundup =================== -:Version: $Revision: 1.14 $ +:Version: $Revision: 1.15 $ .. contents:: @@ -10,12 +10,13 @@ Customising Roundup What You Can Do --------------- -Customisation of Roundup can take one of four forms: +Customisation of Roundup can take one of five forms: 1. `instance configuration`_ file changes 2. database, or `instance schema`_ changes 3. "definition" class `database content`_ changes 4. behavioural changes, through detectors_ +5. `access controls`_ The third case is special because it takes two distinctly different forms depending upon whether the instance has been initialised or not. The other two @@ -913,8 +914,8 @@ eliminate sections of the spool section if the property has no entries:: -Security --------- +Access Controls +--------------- A set of Permissions are built in to the security module by default: @@ -924,12 +925,14 @@ A set of Permissions are built in to the security module by default: The default interfaces define: - Web Registration +- Web Access - Email Registration +- Email Access These are hooked into the default Roles: - Admin (Edit everything, View everything) -- User () +- User (Web Access, Email Access) - Anonymous (Web Registration, Email Registration) And finally, the "admin" user gets the "Admin" Role, and the "anonymous" user @@ -951,6 +954,9 @@ You may alter the configuration variables to change the Role that new web or email users get, for example to not give them access to the web interface if they register through email. +You may use the ``roundup-admin`` "``security``" command to display the +current Role and Permission configuration in your instance. + ----------------- diff --git a/doc/developers.txt b/doc/developers.txt index de991c0..3e51a09 100644 --- a/doc/developers.txt +++ b/doc/developers.txt @@ -2,7 +2,7 @@ Developing Roundup ================== -:Version: $Revision: 1.2 $ +:Version: $Revision: 1.3 $ Note: the intended audience of this document is the developers of the core Roundup code. If you just wish to alter some behaviour of your Roundup @@ -35,15 +35,29 @@ CVS Access To get CVS access, contact richard@users.sourceforge.net. -Developers with CVS access should follow these simple guidelines: +Project Rules +------------- + +Mostly the project follows Guido's Style (though naming tends to be a little +relaxed sometimes). In short: + +- 80 column width code +- 4-space indentations +- All modules must have a CVS Id line near the top, and a CVS Log at the end + +Other project rules: + +- New functionality must be documented, even briefly (so at least we know + where there's missing documentation) and changes to instance configuration + must be logged in the upgrading document. - subscribe to roundup-checkins to receive checkin notifications from the other developers with CVS access - discuss any changes with the other developers on roundup-dev. If nothing else, this makes sure there's no rude shocks -- run pychecker over changed code - write unit tests for changes you make (where possible), and ensure that all unit tests run before committing changes +- run pychecker over changed code The administrators of the project reserve the right to boot developers who consistently check in code which is either broken or takes the codebase in diff --git a/doc/upgrading.txt b/doc/upgrading.txt index c80ebd8..9568823 100644 --- a/doc/upgrading.txt +++ b/doc/upgrading.txt @@ -20,6 +20,7 @@ TODO: dbinit now imports classes from selct_db TODO: select_db needs fixing to include Class, FileClass and IssueClass TODO: migration of security settings TODO: nosy reactor has been updated +TODO: user.item template html needs updating for new security Migrating from 0.4.1 to 0.4.2 -- 2.30.2