Mercurial > p > roundup > code
comparison doc/user_guide.txt @ 7278:e2f257ef737f
alt text for images; captions for tables; RESt/XMLRPC reference
Grammar fix.
Add height/width alt text keeping width under 700 for all images.
Separate two tables and add captions for them.
Reference REST/XMLRPC for automation/advanced use in web interface section.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 25 Apr 2023 02:09:52 -0400 |
| parents | 9c067ed4568b |
| children | 0bf616cfa178 |
comparison
equal
deleted
inserted
replaced
| 7277:41b2a0e12899 | 7278:e2f257ef737f |
|---|---|
| 40 | 40 |
| 41 | 41 |
| 42 Accessing the Tracker | 42 Accessing the Tracker |
| 43 --------------------- | 43 --------------------- |
| 44 | 44 |
| 45 You may access your tracker through one of three ways: | 45 You may access your tracker in three ways: |
| 46 | 46 |
| 47 1. through the `web interface`_, | 47 1. through the `web interface`_, |
| 48 2. through the `e-mail gateway`_, or | 48 2. through the `e-mail gateway`_, or |
| 49 3. using the `command line tool`_. | 49 3. using the `command line tool`_. |
| 50 | 50 |
| 66 If an issue is closed, and a new message is received then it'll be | 66 If an issue is closed, and a new message is received then it'll be |
| 67 reopened to the state of "chatting". | 67 reopened to the state of "chatting". |
| 68 | 68 |
| 69 The full set of **priority** and **status** values are: | 69 The full set of **priority** and **status** values are: |
| 70 | 70 |
| 71 =========== ===================================== | 71 .. table:: Default priorities defined for the classic template. |
| 72 Priority Description | 72 :name: priority table |
| 73 =========== ===================================== | 73 :widths: auto |
| 74 "critical" panic: work is stopped! | 74 |
| 75 "urgent" important, but not deadly | 75 =========== ===================================== |
| 76 "bug" lost work or incorrect results | 76 Priority Description |
| 77 "feature" want missing functionality | 77 =========== ===================================== |
| 78 "wish" avoidable bugs, missing conveniences | 78 "critical" panic: work is stopped! |
| 79 =========== ===================================== | 79 "urgent" important, but not deadly |
| 80 | 80 "bug" lost work or incorrect results |
| 81 ============= ===================================== | 81 "feature" want missing functionality |
| 82 Status Description | 82 "wish" avoidable bugs, missing conveniences |
| 83 ============= ===================================== | 83 =========== ===================================== |
| 84 "unread" submitted but no action yet | 84 |
| 85 "deferred" intentionally set aside | 85 |
| 86 "chatting" under review or seeking clarification | 86 .. table:: Default statuses defined for the classic template. |
| 87 "need-eg" need a reproducible example of a bug | 87 :name: status table |
| 88 "in-progress" understood; development in progress | 88 :widths: auto |
| 89 "testing" we think it's done; others, please test | 89 |
| 90 "done-cbb" okay for now, but could be better | 90 ============= ===================================== |
| 91 "resolved" fix has been released | 91 Status Description |
| 92 ============= ===================================== | 92 ============= ===================================== |
| 93 "unread" submitted but no action yet | |
| 94 "deferred" intentionally set aside | |
| 95 "chatting" under review or seeking clarification | |
| 96 "need-eg" need a reproducible example of a bug | |
| 97 "in-progress" understood; development in progress | |
| 98 "testing" we think it's done; others, please test | |
| 99 "done-cbb" okay for now, but could be better | |
| 100 "resolved" fix has been released | |
| 101 ============= ===================================== | |
| 93 | 102 |
| 94 | 103 |
| 95 .. _query-tracker: | 104 .. _query-tracker: |
| 96 | 105 |
| 97 Entering values in your Tracker | 106 Entering values in your Tracker |
| 256 | 265 |
| 257 1. `lists of items`_, | 266 1. `lists of items`_, |
| 258 2. `display, edit or entry of an item`_, and | 267 2. `display, edit or entry of an item`_, and |
| 259 3. `searching page`_. | 268 3. `searching page`_. |
| 260 | 269 |
| 270 In addition to the graphical web interface, Roundup has `REST`_ and | |
| 271 `XMLRPC`_ interfaces. These can be used by advanced users and | |
| 272 programmers to automate tasks and integrate with other programs. | |
| 273 | |
| 274 .. _REST: rest.html | |
| 275 .. _XMLRPC: xmlrpc.html | |
| 261 | 276 |
| 262 Lists of Items | 277 Lists of Items |
| 263 -------------- | 278 -------------- |
| 264 | 279 |
| 265 The first thing you'll see when you log into Roundup will be a list of | 280 The first thing you'll see when you log into Roundup will be a list of |
| 266 open (ie. not resolved) issues. This list has been generated by a bunch | 281 open (ie. not resolved) issues. This list has been generated by a bunch |
| 267 of controls `under the covers`_ but for now, you can see something like: | 282 of controls `under the covers`_ but for now, you can see something like: |
| 268 | 283 |
| 269 .. image:: images/index_logged_out.png | 284 .. image:: images/index_logged_out.png |
| 285 :width: 675 | |
| 286 :height: 450 | |
| 287 :alt: Image of the classic Roundup tracker showing a list of issues | |
| 288 that one would see before logging in. | |
| 270 | 289 |
| 271 The screen is divided up into three sections. There's a title which tells | 290 The screen is divided up into three sections. There's a title which tells |
| 272 you where you are, a sidebar which contains useful navigation tools and a | 291 you where you are, a sidebar which contains useful navigation tools and a |
| 273 body which usually displays either a list of items or a single item from | 292 body which usually displays either a list of items or a single item from |
| 274 the tracker. | 293 the tracker. |
| 275 | 294 |
| 276 You may register, reset your password or log in. Registration takes | 295 You may register, reset your password or log in. Registration takes |
| 277 you to: | 296 you to: |
| 278 | 297 |
| 279 .. image:: images/registration.png | 298 .. image:: images/registration.png |
| 299 :width: 675 | |
| 300 :height: 450 | |
| 301 :alt: A registration form with fields for name, login name, | |
| 302 password etc. | |
| 280 | 303 |
| 281 Clicking on the "Lost your login?" link allows you to reset your | 304 Clicking on the "Lost your login?" link allows you to reset your |
| 282 password. Resetting your password takes you to: | 305 password. Resetting your password takes you to: |
| 283 | 306 |
| 284 .. image:: images/reset.png | 307 .. image:: images/reset.png |
| 308 :width: 605 | |
| 309 :height: 495 | |
| 310 :alt: A form with email address and username fields that will | |
| 311 trigger a password reset when submitted. | |
| 285 | 312 |
| 286 You can enter your username to get a reset email sent to your primary | 313 You can enter your username to get a reset email sent to your primary |
| 287 E-mail address. Otherwise you can enter your primary E-mail address or | 314 E-mail address. Otherwise you can enter your primary E-mail address or |
| 288 an Alternate E-mail address to get a reset email sent to that address. | 315 an Alternate E-mail address to get a reset email sent to that address. |
| 289 The reset email includes a verification link that can be used to | 316 The reset email includes a verification link that can be used to |
| 290 complete the password reset. The verification link expires in a week. | 317 complete the password reset. The verification link expires in a week. |
| 291 | 318 |
| 292 Once you're logged in, the sidebar changes to: | 319 Once you're logged in, the sidebar changes to: |
| 293 | 320 |
| 294 .. image:: images/index_logged_in.png | 321 .. image:: images/index_logged_in.png |
| 322 :width: 182 | |
| 323 :height: 399 | |
| 324 :alt: Navigation sidebar after login showing multiple links. It now | |
| 325 includes a link labeled "My Details" for the user's settings. | |
| 295 | 326 |
| 296 You can now get to your "My Details" page: | 327 You can now get to your "My Details" page: |
| 297 | 328 |
| 298 .. image:: images/my_details.png | 329 .. image:: images/my_details.png |
| 299 | 330 :width: 667 |
| 331 :height: 558 | |
| 332 :alt: A form allowing the user to change username, real name, email | |
| 333 address and it also shows activity done by the user. | |
| 300 | 334 |
| 301 Display, edit or entry of an item | 335 Display, edit or entry of an item |
| 302 --------------------------------- | 336 --------------------------------- |
| 303 | 337 |
| 304 Create a new issue with "create new" under the issue subheading. This | 338 Create a new issue with "create new" under the issue subheading. This |
| 305 will take you to: | 339 will take you to: |
| 306 | 340 |
| 307 .. image:: images/new_issue.png | 341 .. image:: images/new_issue.png |
| 342 :width: 648 | |
| 343 :height: 277 | |
| 344 :alt: A form for entering a new issue with title, priority, status | |
| 345 and other fields. All fields are empty. It also includes an | |
| 346 entry box for typing free form text to describe the issue. | |
| 308 | 347 |
| 309 Editing an issue uses the same form, though now you'll see attached files | 348 Editing an issue uses the same form, though now you'll see attached files |
| 310 and messages, and the issue history at the bottom of the page: | 349 and messages, and the issue history at the bottom of the page: |
| 311 | 350 |
| 312 .. image:: images/edit_issue.png | 351 .. image:: images/edit_issue.png |
| 352 :width: 650 | |
| 353 :height: 535 | |
| 354 :alt: A form for editing an issue with title, priority, status | |
| 355 and other fields filled in. It also includes an entry box for | |
| 356 typing free form text to describe the issue. | |
| 313 | 357 |
| 314 The "Make a copy" link duplicate the current issue copying most of the | 358 The "Make a copy" link duplicate the current issue copying most of the |
| 315 properties to a new issue. This is useful for splitting am issue into | 359 properties to a new issue. This is useful for splitting am issue into |
| 316 sub-issues that can be assigned to different people. | 360 sub-issues that can be assigned to different people. |
| 317 | 361 |