From 381116f2509db4888463cb3b326d161c8958d9a4 Mon Sep 17 00:00:00 2001 From: richard Date: Tue, 27 Aug 2002 21:55:35 +0000 Subject: [PATCH] Fixes to doc git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@996 57a73879-2fb5-44c3-a270-3262357dd7e2 --- doc/Makefile | 2 +- doc/getting_started.txt | 39 +++++++++++++++++++++++---------------- doc/installation.txt | 8 +++++--- doc/upgrading.txt | 1 + 4 files changed, 30 insertions(+), 20 deletions(-) diff --git a/doc/Makefile b/doc/Makefile index 1141e14..5a55ed4 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -10,5 +10,5 @@ COMPILED := $(SOURCE:.txt=.html) all: ${COMPILED} %.html: %.txt - ${PYTHON} ${STXTOHTML} -d $< $@ + ${PYTHON} ${STXTOHTML} --report=warning -d $< $@ diff --git a/doc/getting_started.txt b/doc/getting_started.txt index cef6f00..b5e8c37 100644 --- a/doc/getting_started.txt +++ b/doc/getting_started.txt @@ -2,7 +2,7 @@ Getting Started =============== -:Version: $Revision: 1.3 $ +:Version: $Revision: 1.4 $ .. contents:: @@ -45,26 +45,18 @@ Instances are created using the ``roundup-admin`` tool. Command Line Tool ----------------- -To initiliase a new instance, run "``roundup-admin init``". You will be asked a -series of questions: +To set up a new instance, run "``roundup-admin install``". You will be +asked a few questions: 1. Instance home directory 2. Schema to use 3. Database back-end to use -4. Administration user "admin" password. -You should also think about whether there is going to be controlled access -to the -instance on the machine the instance is running on. That is, who can -actually make -changes to the database using the roundup-admin tool. See the section on -Users_and_Access_Control for information on how to secure your instance from the -start. - -Roundup is configurable using an ``instance_config.py`` file in the instance -home. It -should be edited before roundup is used, and may have the following variable -declarations: +Once you've chosen these, roundup will install the instance for you. It will +then indicate that you should configure some more information in the +file "``instance_config.py``" in the instance home. It +should be edited before roundup is initialised, and may have the following +variable declarations: MAILHOST The SMTP mail host that roundup will use to send mail @@ -81,6 +73,20 @@ ISSUE_TRACKER_EMAIL: ``issue_tracker@MAIL_DOMAIN`` ADMIN_EMAIL: ``roundup-admin@MAIL_DOMAIN`` roundup's internal use (problems, etc) +You may also alter the default schema - see the `customisation`_ documentation +for more info on both configuration variables and schema modifications. + +Once you're happy (and note that you can change any of this after the instance +is initialised too!) you must run "``roundup-admin initialise``". + +You should also think about whether there is going to be controlled access +to the +instance on the machine the instance is running on. That is, who can +actually make +changes to the database using the roundup-admin tool. See the section on +Users_and_Access_Control for information on how to secure your instance from the +start. + E-Mail Interface ---------------- @@ -269,4 +275,5 @@ Next: `User Guide`_ .. _`table of contents`: index.html .. _`user guide`: user_guide.html +.. _`customisation`: customizing.html diff --git a/doc/installation.txt b/doc/installation.txt index 374f829..c2186c8 100644 --- a/doc/installation.txt +++ b/doc/installation.txt @@ -2,7 +2,7 @@ Installing Roundup ================== -:Version: $Revision: 1.14 $ +:Version: $Revision: 1.15 $ .. contents:: @@ -124,12 +124,14 @@ Python -- see `testing your python`_. You will now be directed to edit the instance configuration and initial schema. See `Customising Roundup`_ for details on configuration - and schema changes. + and schema changes. Note that you may change any of the configuration + after you've initialised the instance - it's just better to have valid + values for this stuff now. d. ``roundup-admin initialise`` This step initialises the instance database. You will need to supply - an admin password at this step. You will be prompted: + an admin password at this step. You will be prompted:: Admin Password: Confirm: diff --git a/doc/upgrading.txt b/doc/upgrading.txt index 9568823..0e10ad3 100644 --- a/doc/upgrading.txt +++ b/doc/upgrading.txt @@ -21,6 +21,7 @@ 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 +TODO: maybe something about export/import? Migrating from 0.4.1 to 0.4.2 -- 2.30.2