From 3ef2258e46f2620562c3feb5ccf8e13508dabc04 Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Sat, 5 Dec 2015 22:14:08 +0100 Subject: [PATCH] Update Getting Help documentation. --- doc/source/help.rst | 46 +++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 41 insertions(+), 5 deletions(-) diff --git a/doc/source/help.rst b/doc/source/help.rst index d3ddeaa..1571a9d 100644 --- a/doc/source/help.rst +++ b/doc/source/help.rst @@ -3,8 +3,44 @@ Getting Help ============ -Any questions, bug reports, or suggested enhancements related to -ctools should be submitted via the -`issue tracker `_ -or the -`mailing list `_. \ No newline at end of file +If you need help you should first check the +:ref:`Frequently Asked Questions ` and the list of +:ref:`Known Issues `. +In case that you do not find an answer to your question you may post your +question on the ctools@irap.omp.eu mailing list. +To subscribe to this list you simply need to send an e-mail to +ctools-subscribe@irap.omp.eu (content is irrelevant). + +You can also use the `Redmine `_ +system that we use for the ctools software development management to ask for +support, report a bug, or request a new feature. To use the system you +will first need to +`register `_. + +Once registered, you can sign-in and ask for support by creating a +`support issue `_. +Specify ``Support`` as Tracker, choose a short and meaningful subject, +and add an exhaustive description of your request. + +If you find a bug you should first check the +`list of bugs `_ +to see whether your bug is already known. If the bug is known, you may edit +the issue and add some information (e.g. a log file, screen shot, etc.). +If the bug is not yet known, please create a +`bug issue `_. +Specify ``Bug`` as Tracker, provide a short and meaningful subject, and add +an exhaustive description of the bug. Include the ctools software version, +your operating system, and the conditions under which the bug occurred. Ideally +you should provide all files and the command sequence (or a script) that +will allow us to reproduce the bug. + +If you would like to suggest some enhancements to ctools you should create +a +`feature issue `_. +Specify ``Feature`` as Tracker, choose a short and meaningful subject, +and add an exhaustive description of your feature request. +Also explain the motivation for your request and provide some hint on how +urgently you need the new feature. + +You may click on ``Watch`` in the top-right corner of the issue page to make sure +that you will receive an e-mail notification when the issue is updated. \ No newline at end of file -- libgit2 0.21.4