Commit 3ef2258e46f2620562c3feb5ccf8e13508dabc04
1 parent
555cf500
Update Getting Help documentation.
Showing
1 changed file
with
41 additions
and
5 deletions
doc/source/help.rst
| ... | ... | @@ -3,8 +3,44 @@ |
| 3 | 3 | Getting Help |
| 4 | 4 | ============ |
| 5 | 5 | |
| 6 | -Any questions, bug reports, or suggested enhancements related to | |
| 7 | -ctools should be submitted via the | |
| 8 | -`issue tracker <https://cta-redmine.irap.omp.eu/projects/ctools/issues/new>`_ | |
| 9 | -or the | |
| 10 | -`mailing list <mailto:ctools@irap.omp.eu>`_. | |
| 11 | 6 | \ No newline at end of file |
| 7 | +If you need help you should first check the | |
| 8 | +:ref:`Frequently Asked Questions <faq>` and the list of | |
| 9 | +:ref:`Known Issues <issues>`. | |
| 10 | +In case that you do not find an answer to your question you may post your | |
| 11 | +question on the ctools@irap.omp.eu mailing list. | |
| 12 | +To subscribe to this list you simply need to send an e-mail to | |
| 13 | +ctools-subscribe@irap.omp.eu (content is irrelevant). | |
| 14 | + | |
| 15 | +You can also use the `Redmine <https://cta-redmine.irap.omp.eu/projects/ctools>`_ | |
| 16 | +system that we use for the ctools software development management to ask for | |
| 17 | +support, report a bug, or request a new feature. To use the system you | |
| 18 | +will first need to | |
| 19 | +`register <https://cta-redmine.irap.omp.eu/account/register>`_. | |
| 20 | + | |
| 21 | +Once registered, you can sign-in and ask for support by creating a | |
| 22 | +`support issue <https://cta-redmine.irap.omp.eu/projects/ctools/issues/new>`_. | |
| 23 | +Specify ``Support`` as Tracker, choose a short and meaningful subject, | |
| 24 | +and add an exhaustive description of your request. | |
| 25 | + | |
| 26 | +If you find a bug you should first check the | |
| 27 | +`list of bugs <https://cta-redmine.irap.omp.eu/projects/ctools/issues?utf8=?&set_filter=1&f%5B%5D=status_id&op%5Bstatus_id%5D=*&f%5B%5D=tracker_id&op%5Btracker_id%5D=%3D&v%5Btracker_id%5D%5B%5D=1&f%5B%5D=&c%5B%5D=tracker&c%5B%5D=status&c%5B%5D=priority&c%5B%5D=subject&c%5B%5D=assigned_to&c%5B%5D=updated_on&c%5B%5D=fixed_version&c%5B%5D=done_ratio&group_by=>`_ | |
| 28 | +to see whether your bug is already known. If the bug is known, you may edit | |
| 29 | +the issue and add some information (e.g. a log file, screen shot, etc.). | |
| 30 | +If the bug is not yet known, please create a | |
| 31 | +`bug issue <https://cta-redmine.irap.omp.eu/projects/ctools/issues/new>`_. | |
| 32 | +Specify ``Bug`` as Tracker, provide a short and meaningful subject, and add | |
| 33 | +an exhaustive description of the bug. Include the ctools software version, | |
| 34 | +your operating system, and the conditions under which the bug occurred. Ideally | |
| 35 | +you should provide all files and the command sequence (or a script) that | |
| 36 | +will allow us to reproduce the bug. | |
| 37 | + | |
| 38 | +If you would like to suggest some enhancements to ctools you should create | |
| 39 | +a | |
| 40 | +`feature issue <https://cta-redmine.irap.omp.eu/projects/ctools/issues/new>`_. | |
| 41 | +Specify ``Feature`` as Tracker, choose a short and meaningful subject, | |
| 42 | +and add an exhaustive description of your feature request. | |
| 43 | +Also explain the motivation for your request and provide some hint on how | |
| 44 | +urgently you need the new feature. | |
| 45 | + | |
| 46 | +You may click on ``Watch`` in the top-right corner of the issue page to make sure | |
| 47 | +that you will receive an e-mail notification when the issue is updated. | |
| 12 | 48 | \ No newline at end of file | ... | ... |