Mercurial > p > roundup > code
comparison doc/user_guide.txt @ 8061:b1d384d23cdb
docs: cleanups suggested by vale.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 08 Jul 2024 13:04:05 -0400 |
| parents | d54af8964fe3 |
| children | 188b7a549f20 |
comparison
equal
deleted
inserted
replaced
| 8060:f53fd57a0cf3 | 8061:b1d384d23cdb |
|---|---|
| 18 | 18 |
| 19 | 19 |
| 20 Your Tracker in a Nutshell | 20 Your Tracker in a Nutshell |
| 21 ========================== | 21 ========================== |
| 22 | 22 |
| 23 Your tracker holds information about issues in bundles we call *items*. | 23 Your tracker holds information about issues in bundles called *items*. |
| 24 An item may be an *issue* (a bug or feature request) or a *user*. The | 24 An item can be an *issue* (a bug or feature request) or a *user*. The |
| 25 issue-ness or user-ness is called the item's *class*. So, for bug | 25 issue-ness or user-ness is called the item's *class*. For bug |
| 26 reports and features, the class is "issue", and for users the class is | 26 reports and features, the class is "issue", and for users the class is |
| 27 "user". | 27 "user". |
| 28 | 28 |
| 29 Each item in the tracker has an ID number that identifies it along with | 29 Each item in the tracker possesses an ID number that identifies it |
| 30 its item class. To identify a particular issue or user, we combine the | 30 alongside its item class. The combination of the class and ID number |
| 31 class with the number to create a unique label, so that user 1 (who, | 31 into a label identifies a specific issue or user. For instance, user 1 |
| 32 incidentally, is *always* the "admin" user) is referred to as "user1". | 32 (who, by the way, always serves as the "admin" user) gets referred to |
| 33 Issue number 315 is referred to as "issue315". We call that label the | 33 as "user1". Issue number 315 gets denoted as "issue315". This label |
| 34 item's :term:`designator`. | 34 receives the designation of the item's :term:designator. |
| 35 | 35 |
| 36 Items in the database are never deleted, they're just "retired". You | 36 Roundup never deletes items from the database. Instead, items get |
| 37 can still refer to them by ID - hence removing an item won't break | 37 "retired". Viewing the item using its ID is still possible - thus, |
| 38 references to the item. It's just that the item won't appear in any | 38 "removing" an item does not disrupt references to it. A retired item |
| 39 listings. | 39 will not appear in the class listing. |
| 40 | |
| 41 | 40 |
| 42 Accessing the Tracker | 41 Accessing the Tracker |
| 43 --------------------- | 42 --------------------- |
| 44 | 43 |
| 45 You may access your tracker in three ways: | 44 You may access your tracker in three ways: |
| 56 Issue life cycles in Roundup | 55 Issue life cycles in Roundup |
| 57 ---------------------------- | 56 ---------------------------- |
| 58 | 57 |
| 59 New issues may be submitted via the web or e-mail. | 58 New issues may be submitted via the web or e-mail. |
| 60 | 59 |
| 61 By default, the issue will have the status "unread". If another message | 60 By default, the issue will have the status "unread". When the issue |
| 62 is received for the issue, its status will change to "chatting". | 61 receives another message, its status will change to "chatting". |
| 63 | 62 |
| 64 The "home" page for a tracker will generally display all issues which | 63 Often, the "home" page for a tracker display all open issues (closed |
| 65 are not "resolved". | 64 issues have a status of resolved, or done-cbb (cbb - could be |
| 65 better)). | |
| 66 | 66 |
| 67 If an issue is closed, and a new message is received then it'll be | 67 If an issue is closed, and a new message is received then it'll be |
| 68 reopened to the state of "chatting". | 68 reopened to the state of "chatting". |
| 69 | 69 |
| 70 The full set of **priority** and **status** values are: | 70 The full set of **priority** and **status** values are: |
| 99 "testing" we think it's done; others, please test | 99 "testing" we think it's done; others, please test |
| 100 "done-cbb" okay for now, but could be better | 100 "done-cbb" okay for now, but could be better |
| 101 "resolved" fix has been released | 101 "resolved" fix has been released |
| 102 ============= ===================================== | 102 ============= ===================================== |
| 103 | 103 |
| 104 The tracker you are using may have different priorities and | |
| 105 statuses. See your tracker admin for local details. | |
| 104 | 106 |
| 105 .. _query-tracker: | 107 .. _query-tracker: |
| 106 | 108 |
| 107 Entering values in your Tracker | 109 Entering values in your Tracker |
| 108 ------------------------------- | 110 ------------------------------- |
| 110 All interfaces to your tracker use the same format for entering values. | 112 All interfaces to your tracker use the same format for entering values. |
| 111 This means the web interface for entering a new issue, the web interface | 113 This means the web interface for entering a new issue, the web interface |
| 112 for searching issues, the e-mail interface and even the command-line | 114 for searching issues, the e-mail interface and even the command-line |
| 113 administration tool. | 115 administration tool. |
| 114 | 116 |
| 115 | |
| 116 String and Numeric properties | 117 String and Numeric properties |
| 117 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 118 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 118 | 119 |
| 119 These fields just take a simple text value, like ``It's broken``. | 120 These fields just take a plain text value, like ``It's broken``. |
| 120 | 121 |
| 121 | 122 |
| 122 Boolean properties | 123 Boolean properties |
| 123 ~~~~~~~~~~~~~~~~~~ | 124 ~~~~~~~~~~~~~~~~~~ |
| 124 | 125 |