Mercurial > p > roundup > code

comparison doc/installation.stx @ 655:35cdc70e6a96

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More doc fixes.
author Richard Jones <richard@users.sourceforge.net>
date Sat, 09 Mar 2002 22:46:52 +0000
parents 1dcbee29faa7
children
comparison
equal deleted inserted replaced
654:2973911cb674 655:35cdc70e6a96
1 *Roundup (0.4.1): An Issue-Tracking System for Knowledge Workers* 1 Installing Roundup
2 ==================
2 3
3 `Table of contents`_ 4 `Table of contents`_
4 5
5 - Overview_ 6 - Overview_
7
8 - `Classic Template`_
9 - `Extended Template`_
10
6 - Prerequisites_ 11 - Prerequisites_
7 12
8 - `Testing your Python`_ 13 - `Testing your Python`_
9 14
10 - `Getting Roundup`_ 15 - `Getting Roundup`_
12 - `Further Reading`_ 17 - `Further Reading`_
13 - `Platform-Specific Notes`_ 18 - `Platform-Specific Notes`_
14 19
15 Overview 20 Overview
16 ======== 21 ========
17
18 TODO
19
20 Prerequisites
21 =============
22
23 Python 2.1.1 or newer with a functioning anydbm or bsddb module.
24
25 Download the latest version from http://www.python.org/.
26
27
28 Testing your Python
29 -------------------
30
31 Run ``"python -c 'import test;test.go()'"`` and make sure there
32 are no errors. If there are errors, please let us know!
33
34
35 Getting Roundup
36 ===============
37
38 Download the latest version from http://roundup.sf.net/.
39
40
41 Installation
42 ============
43
44 Set aside 15-30 minutes.
45 22
46 Broken out separately, there are several conceptual pieces to a 23 Broken out separately, there are several conceptual pieces to a
47 Roundup installation: 24 Roundup installation:
48 25
49 Roundup support code 26 Roundup support code
56 Roundup instances 33 Roundup instances
57 Instances consist of core support files, issues 34 Instances consist of core support files, issues
58 (be they bug reports or otherwise), instance configuration file(s), 35 (be they bug reports or otherwise), instance configuration file(s),
59 etc. Roundup instances also adhere to a specific "Template" which 36 etc. Roundup instances also adhere to a specific "Template" which
60 defines the fields usable/assignable on a per-issue basis. A 37 defines the fields usable/assignable on a per-issue basis. A
61 description of the provided templates can be found under the 38 description of the provided templates follows.
62 'TODO' section. 39
40 Classic Template
41 ----------------
42
43 The classic template is the one defined in the `Roundup Specification`_. It
44 holds issues which have priorities and statuses. Each issue may also have a
45 set of messages which are disseminated to the issue's list of nosy users.
46
47
48 Extended Template
49 -----------------
50
51 The extended template adds additional information to issues: product,
52 platform, version, targetversion and supportcall.
53 There is an additional class for
54 handling support calls, which includes a time log, customername, rate and
55 source.
56
57 The priorty class has different default entries too: "fatal-bug", "bug",
58 "usability" and "feature".
59
60 Users of this template will want to change the contents of the product
61 class as soon as the instance is created.
62
63
64 Prerequisites
65 =============
66
67 Python 2.1.1 or newer with a functioning anydbm or bsddb module.
68
69 Download the latest version from http://www.python.org/.
70
71
72 Testing your Python
73 -------------------
74
75 Run ``"python -c 'import test;test.go()'"`` and make sure there
76 are no errors. If there are errors, please let us know!
77
78
79 Getting Roundup
80 ===============
81
82 Download the latest version from http://roundup.sf.net/.
83
84
85 Installation
86 ============
87
88 Set aside 15-30 minutes.
63 89
64 1. To install the Roundup support code into your Python tree and 90 1. To install the Roundup support code into your Python tree and
65 Roundup scripts into /usr/local/bin:: 91 Roundup scripts into /usr/local/bin::
66 92
67 python setup.py install 93 python setup.py install
87 the command in the next step. 113 the command in the next step.
88 114
89 c. ``roundup-admin init`` 115 c. ``roundup-admin init``
90 116
91 You will be asked a series of questions. A description of 117 You will be asked a series of questions. A description of
92 the Roundup-provided templates can be found under TODO:: 118 the Roundup-provided templates can be found under the Overview_::
93 119
94 Enter instance home: /opt/roundup/instances/support 120 Enter instance home: /opt/roundup/instances/support
95 Templates: classic, extended 121 Templates: classic, extended
96 Select template [classic]: classic 122 Select template [classic]: classic
97 Back ends: anydbm, bsddb 123 Back ends: anydbm, bsddb
155 Further Reading 181 Further Reading
156 =============== 182 ===============
157 183
158 If you intend to use Roundup with anything other than the defualt 184 If you intend to use Roundup with anything other than the defualt
159 templates, if you would like to hack on Roundup, or if you would 185 templates, if you would like to hack on Roundup, or if you would
160 like implementation details, you should read 'TODO' 186 like implementation details, you should read `Customising Roundup`_.
187
161 188
162 Platform-Specific Notes 189 Platform-Specific Notes
163 ======================= 190 =======================
164 191
165 Sendmail smrsh 192 Sendmail smrsh
188 215
189 Next: `Getting Started`_ 216 Next: `Getting Started`_
190 217
191 .. _`table of contents`: index.html 218 .. _`table of contents`: index.html
192 .. _`getting started`: getting_started.html 219 .. _`getting started`: getting_started.html
193 220 .. _`roundup specification`: spec.html
194 $Id: installation.stx,v 1.2 2002-03-08 23:41:46 richard Exp $ 221 .. _`customising roundup`: customizing.html
222
223 $Id: installation.stx,v 1.3 2002-03-09 22:46:52 richard Exp $
Roundup Issue Tracker: http://roundup-tracker.org/