Skip to content

Commit b1c1baa

Browse files
committed
Misc doc fixes.
1 parent 31853cf commit b1c1baa

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

doc/installation.txt

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,8 @@ Timezone Definitions
103103
An RDBMS
104104
Sqlite, MySQL and Postgresql are all supported by Roundup and will be
105105
used if available. One of these is recommended if you are anticipating a
106-
large user base (see `choosing your backend`_ below).
107-
108-
.. index:: roundup-admin:: reindex subcommand
106+
large user base (see `choosing your backend`_ below). Sqlite should
107+
always be available.
109108

110109
Xapian full-text indexer
111110
The Xapian_ full-text indexer is also supported and will be used by
@@ -220,7 +219,7 @@ installation:
220219
3. then optionally `configure a web interface`_
221220
4. and optionally `configure an email interface`_
222221
5. `UNIX environment steps`_ to take if you're installing on a shared
223-
UNIX machine and want to restrict local access to roundup
222+
UNIX machine and want to restrict local access to Roundup
224223

225224
For information about how Roundup installs, see the `administration
226225
guide`_.
@@ -231,7 +230,7 @@ Basic Installation Steps
231230
------------------------
232231

233232
Installation of Roundup using Python3 in a virtual environment is
234-
probably the path of least resistance. Use::
233+
recommended. Use::
235234

236235
python3 -m venv /path/to/environment/roundup
237236

@@ -240,7 +239,7 @@ the Python environment using::
240239

241240
. /path/to/environment/roundup/bin/activate
242241

243-
then use the alias ``deactivate`` to return to the normal Python
242+
You can use the alias ``deactivate`` to return to the normal Python
244243
environment. If you create the virtual envirnment as a non-root user,
245244
you can install below using the same user.
246245

@@ -461,15 +460,14 @@ Configuring your first tracker
461460
third-party database modules. Standard python distribution
462461
includes anydbm and sqlite module only.
463462

464-
The "support" part of the tracker name can be anything you want - it
465-
is going to be used as the directory that the tracker information
466-
will be stored in.
463+
The "support" part of the tracker home can be anything you want - it
464+
is the directory where the tracker information will be stored.
467465

468466
You will now be directed to edit the tracker configuration and
469-
initial schema. At a minimum, you must set "tracker :: web",
467+
initial schema. At a minimum, you must set "tracker :: web"
468+
(that's the "web" option in the "tracker" section),
470469
"mail :: host", and "mail :: domain". You should also
471-
set "main :: admin_email" (that's the "admin_email" option in
472-
the "main" section) to your local admin address to get email
470+
set "main :: admin_email" to your local admin address to get email
473471
on unusual occurances. If you get stuck,
474472
and get configuration file errors, then see the `tracker
475473
configuration`_ section of the `customisation documentation`_.
@@ -519,12 +517,12 @@ Configuring your first tracker
519517
and you should see the tracker interface.
520518

521519
To run your tracker on some interface other than 127.0.0.1 and port
522-
8080 (make sure you change the "tracker :: web" changes to match) use::
520+
8080 (make sure you change the "tracker :: web" option to match) use::
523521

524522
roundup-server -p 1080 -n 0.0.0.0 support=/opt/roundup/trackers/support
525523

526524
to run the server at port 1080 and bind to all ip addresses on your system.
527-
Then direct your web browser to ``http://your_host_name:1080/support``.
525+
Then direct your web browser to ``http://your_host_name:1080/support/``.
528526

529527
Choosing Your Template
530528
----------------------

0 commit comments

Comments
 (0)