Skip to content

Commit 5ca9830

Browse files
author
Richard Jones
committed
more user docco
1 parent ecff7b2 commit 5ca9830

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

doc/user_guide.txt

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
User Guide
33
==========
44

5-
:Version: $Revision: 1.21 $
5+
:Version: $Revision: 1.22 $
66

77
.. contents::
88

@@ -24,6 +24,7 @@ the number to create a unique label, so that user 1 (who, incidentally, is
2424
*always* the "admin" user) is referred to as "user1". Issue number 315 is
2525
referred to as "issue315". We call that label the item's *designator*.
2626

27+
2728
Accessing the Tracker
2829
---------------------
2930

@@ -37,6 +38,21 @@ The last is usually only used by administrators. Most users will use the web
3738
and email interfaces. All three are explained below.
3839

3940

41+
Issue life cycles in Roundup
42+
----------------------------
43+
44+
New issues may be submitted via the web or email.
45+
46+
By default, the issue will have the status "unread". If another message is
47+
received for the issue, its status will change to "chatting".
48+
49+
The "home" page for a tracker will generally display all issues which are
50+
not "resolved.
51+
52+
If an issue is closed, and a new message is received then it'll be reopened
53+
to the state of "chatting".
54+
55+
4056
Entering values in your Tracker
4157
-------------------------------
4258

@@ -278,8 +294,9 @@ E-Mail Gateway
278294
E-mail sent to Roundup is examined for several pieces of information:
279295

280296
1. `subject-line information`_ identifying the purpose of the e-mail
281-
2. `e-mail message content`_ which is to be extracted
282-
3. e-mail attachments which should be associated with the message
297+
2. `sender identification`_ using the sender of the message
298+
3. `e-mail message content`_ which is to be extracted
299+
4. e-mail attachments which should be associated with the message
283300

284301
Subject-line information
285302
------------------------
@@ -352,6 +369,18 @@ Automatic Properties
352369
received.
353370

354371

372+
Sender identification
373+
---------------------
374+
375+
If the sender of an email is unknown to Roundup (looking up both user
376+
primary email addresses and their alternate addresses) then a new user will
377+
be created. The new user will have their username set to the "user" part of
378+
"user@domain" in their email address. Their password will be completely
379+
randomised, and they'll have to visit the web interface to have it
380+
changed. Note that some sites don't allow web access by users who register
381+
via email like this.
382+
383+
355384
E-Mail Message Content
356385
----------------------
357386

0 commit comments

Comments
 (0)