Documentation/Nightly/Report a problem - Revision history

Lasso at 20:59, 12 February 2022

2022-02-12T20:59:14Z

Lasso: moved to readthedocs

2022-02-12T20:58:52Z

moved to readthedocs

Spujol at 19:19, 7 April 2020

2020-04-07T19:19:27Z

Spujol: /* User Feedback */

2020-04-07T14:56:40Z

User Feedback

JChris.FillionR at 04:50, 6 November 2018

2018-11-06T04:50:45Z

Inorton: /* User Feedback */

2017-06-08T13:35:47Z

User Feedback

Inorton: /* User Feedback */

2017-06-08T13:28:33Z

User Feedback

Inorton: /* User Feedback */

2017-06-08T13:24:00Z

User Feedback

JChris.FillionR at 22:12, 10 December 2015

2015-12-10T22:12:32Z

JChris.FillionR at 18:36, 23 November 2015

2015-11-23T18:36:14Z

@@ Line 1: / Line 1: @@
 {{documentation/banner
 | text  = [https://slicer.readthedocs.io/en/latest/user_guide/get_help.html#i-want-to-report-a-problem This page has been moved to read-the-docs.]
 | background-color = 8FBC8F }}

@@ Line 1: / Line 1: @@
 <noinclude>{{documentation/versioncheck}}</noinclude>
-*I have a question about how to use Slicer for a particular task or I'm not sure things are working right
+{{documentation/banner
-**Try your best to sort out the issue by reading documentation and checking error logs
+| text  = [https://slicer.readthedocs.io/en/latest/user_guide/get_help.html#i-want-to-report-a-problem This page has been moved to read-the-docs.]
-***Look at our [[Documentation/UserTraining|portfolio of training materials]] and make a google search to see if the question has been discussed.
+| background-color = 8FBC8F }}

← Older revision		Revision as of 19:19, 7 April 2020
Line 43:		Line 43:

	*5. Post on the [https://discourse.slicer.org/new-topic?body=Operating%20system:%0ASlicer%20version:%0AExpected%20behavior:%0AActual%20behavior:&category=support Discussion Forum] pointing to the reported bug. Title of the post should start with <code>Issue 1234: Title of the issue report</code>		*5. Post on the [https://discourse.slicer.org/new-topic?body=Operating%20system:%0ASlicer%20version:%0AExpected%20behavior:%0AActual%20behavior:&category=support Discussion Forum] pointing to the reported bug. Title of the post should start with <code>Issue 1234: Title of the issue report</code>
−
−	~~{{:Documentation/{{documentation/version}}/Developers/IssueWorkflow}}~~

@@ Line 2: / Line 2: @@
 <noinclude>{{documentation/versioncheck}}</noinclude>
 -->
 =User Feedback=
 *I have a question about how to use Slicer for a particular task or I'm not sure things are working right
-** Try your best to sort out the issue by reading documentation and checking error logs
+**Try your best to sort out the issue by reading documentation and checking error logs
-*** Look at our [[Documentation/UserTraining|portfolio of training materials]] and make a google search to see if the question has been discussed.
+***Look at our [[Documentation/UserTraining|portfolio of training materials]] and make a google search to see if the question has been discussed.
-*** Check the [[Documentation/{{documentation/version}}/SlicerApplication/ErrorLog#To_capture_the_entire_error_log_for_a_report|Error Log]] to see if there's something misconfigured, such as a directory that is not readable or writable.
+***Check the [[Documentation/{{documentation/version}}/SlicerApplication/ErrorLog#To_capture_the_entire_error_log_for_a_report|Error Log]] to see if there's something misconfigured, such as a directory that is not readable or writable.
-** I am still unclear about what to do.
+**I am still unclear about what to do.
-*** <big>[https://discourse.slicer.org Ask a question on the Slicer Forum!]</big>
+***<big>[https://discourse.slicer.org Ask a question on the Slicer Forum!]</big>
 *Something is definitely not working as it should or I would like to request a feature.
-** File a bug report in the issues [http://na-mic.org/Mantis/bug_report_page.php tracker] (you need to register first). It is important to provide enough specific information so that a software developer can duplicate the problem - [[Documentation/{{documentation/version}}/Report_a_problem#Error_report_contents|see details below]].
+**File a bug report in the issues [http://issues.slicer.org/ tracker] (you need to register first). It is important to provide enough specific information so that a software developer can duplicate the problem - [[Documentation/{{documentation/version}}/Report_a_problem#Error_report_contents|see details below]].
-** Don't be anonymous: real people trying hard to solve real problems are more likely to get valuable help.  A vague question from a random email is likely to be ignored..
+**Don't be anonymous: real people trying hard to solve real problems are more likely to get valuable help.  A vague question from a random email is likely to be ignored..
-* I would like to let the Slicer community know, how Slicer helped me in my research.
+*I would like to let the Slicer community know, how Slicer helped me in my research.
 **Please send us the citation for your paper.
 **Background: funding for Slicer is provided through competitive mechanisms to a large extent by the US government and to a lesser extend through funding from other governments. The justification of for those resources is that Slicer enables scientific work. Knowing about scientific publications enabled by Slicer is a critical step in this process. Given the international nature of the Slicer community, the nationality of the scientists is not important. Every good paper counts.
-* I would like to give feedback on my experience with Slicer.
+*I would like to give feedback on my experience with Slicer.
 **Share your story using the Feedback link accessible from the Slicer Welcome module
 ==Error report contents==
 * Describe:
-** What steps were performed before the problem occurred
+*Describe:
-** What behavior you expected
+**What steps were performed before the problem occurred
-** What happened instead
+**What behavior you expected
-* Copy-paste the error log: you can access it from Slicer in the menu: Help / Report a bug. By default log of the current session is displayed but you can retrieve the logs of the last few sessions
+**What happened instead
-* Optional: capture a screenshot that illustrates the issue
+*Copy-paste the error log: you can access it from Slicer in the menu: Help / Report a bug. By default log of the current session is displayed but you can retrieve the logs of the last few sessions
 That could be summarized by the SSCCE (Short, Self Contained, Correct (Compilable), Example) approach documented on http://sscce.org
@@ Line 34: / Line 34: @@
 The following instructions describes the recommended workflow to report a problem related to the Slicer application.
-* 1. [https://issues.slicer.org/signup_page.php Register] on the issue tracker
+*1. [https://issues.slicer.org/signup_page.php Register] on the issue tracker
-* 2. [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-devel Sign-up] on the [https://discourse.slicer.org/ Discussion Forum]
+*2. [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-devel Sign-up] on the [https://discourse.slicer.org/ Discussion Forum]
-* 3. Create an issue in the [https://issues.slicer.org/bug_report_page.php issue tracker].
+*3. Create an issue in the [https://issues.slicer.org/bug_report_page.php issue tracker].
-* 4. Optionally, if you would like to share dataset >= 2MB, you should consider uploading them on our dedicated server. See [[Documentation/{{documentation/version}}/Report_a_problem/UploadData|How to share and associate data with an issue]]
+*4. Optionally, if you would like to share dataset >= 2MB, you should consider uploading them on our dedicated server. See [[Documentation/{{documentation/version}}/Report_a_problem/UploadData|How to share and associate data with an issue]]
-* 5. Post on the [https://discourse.slicer.org/new-topic?body=Operating%20system:%0ASlicer%20version:%0AExpected%20behavior:%0AActual%20behavior:&category=support Discussion Forum] pointing to the reported bug. Title of the post should start with <code>Issue 1234: Title of the issue report</code>
+*5. Post on the [https://discourse.slicer.org/new-topic?body=Operating%20system:%0ASlicer%20version:%0AExpected%20behavior:%0AActual%20behavior:&category=support Discussion Forum] pointing to the reported bug. Title of the post should start with <code>Issue 1234: Title of the issue report</code>
 {{:Documentation/{{documentation/version}}/Developers/IssueWorkflow}}

@@ Line 32: / Line 32: @@
 ==Workflow for Handling Bugs and Feature Requests in Slicer==
-The following instructions describes the recommended workflow to report a problem related to Slicer application.
+The following instructions describes the recommended workflow to report a problem related to the Slicer application.
-* 1. [http://na-mic.org/Mantis/signup_page.php Register] on the issue tracker
+* 1. [https://issues.slicer.org/signup_page.php Register] on the issue tracker
-* 2. [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-devel Sign-up] on the developers mailing list
+* 2. [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-devel Sign-up] on the [https://discourse.slicer.org/ Discussion Forum]
-* 3. Create an issue in the [http://na-mic.org/Mantis/bug_report_page.php tracker].
+* 3. Create an issue in the [https://issues.slicer.org/bug_report_page.php issue tracker].
 * 4. Optionally, if you would like to share dataset >= 2MB, you should consider uploading them on our dedicated server. See [[Documentation/{{documentation/version}}/Report_a_problem/UploadData|How to share and associate data with an issue]]
-* 5. Send an email on the [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-devel slicer-developers] list pointing to the reported bug. Title of the email should start with <code>[BUG 1234] Title of the bug</code>
+* 5. Post on the [https://discourse.slicer.org/new-topic?body=Operating%20system:%0ASlicer%20version:%0AExpected%20behavior:%0AActual%20behavior:&category=support Discussion Forum] pointing to the reported bug. Title of the post should start with <code>Issue 1234: Title of the issue report</code>
 {{:Documentation/{{documentation/version}}/Developers/IssueWorkflow}}

@@ Line 8: / Line 8: @@
 ** Try your best to sort out the issue by reading documentation, mailing list archives, and checking error logs
 *** Look at our [[Documentation/UserTraining|portfolio of training materials]] and make a google search to see, if the question has been discussed in the mailinglists.
-*** I am still unclear about what to do. In this case, [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-users sign up] for the slicer user mailing list and ask your question there
+*** I am still unclear about what to do. In this case, [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-users sign up] for the slicer user mailing list and ask your question there
 *** Check the [[Documentation/{{documentation/version}}/SlicerApplication/ErrorLog#To_capture_the_entire_error_log_for_a_report|Error Log]] to see if there's something misconfigured, such as a directory that is not readable or writable.
 *Something is definitely not working as it should or I would like to request a feature.
-** File a bug report in the issues [http://na-mic.org/Mantis/bug_report_page.php tracker] (you need to register first) or on the [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-users Slicer users mailing list]. It is important to provide enough specific information so that a software developer can duplicate the problem - [[Documentation/{{documentation/version}}/Report_a_problem#Error_report_contents|see details below]].
+** File a bug report in the issues [http://na-mic.org/Mantis/bug_report_page.php tracker] (you need to register first) or on the [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-users Slicer users mailing list]. It is important to provide enough specific information so that a software developer can duplicate the problem - [[Documentation/{{documentation/version}}/Report_a_problem#Error_report_contents|see details below]].
 ** Don't be anonymous: real people trying hard to solve real problems are more likely to get valuable help.  A vague question from a random email is likely to be ignored..
 * I would like to let the Slicer community know, how Slicer helped me in my research.
@@ Line 35: / Line 35: @@
 * 1. [http://na-mic.org/Mantis/signup_page.php Register] on the issue tracker
-* 2. [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel Sign-up] on the developers mailing list
+* 2. [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-devel Sign-up] on the developers mailing list
 * 3. Create an issue in the [http://na-mic.org/Mantis/bug_report_page.php tracker].
@@ Line 41: / Line 41: @@
 * 4. Optionally, if you would like to share dataset >= 2MB, you should consider uploading them on our dedicated server. See [[Documentation/{{documentation/version}}/Report_a_problem/UploadData|How to share and associate data with an issue]]
-* 5. Send an email on the [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel slicer-developers] list pointing to the reported bug. Title of the email should start with <code>[BUG 1234] Title of the bug</code>
+* 5. Send an email on the [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-devel slicer-developers] list pointing to the reported bug. Title of the email should start with <code>[BUG 1234] Title of the bug</code>
 {{:Documentation/{{documentation/version}}/Developers/IssueWorkflow}}

← Older revision		Revision as of 18:36, 23 November 2015
Line 1:		Line 1:
		+	<!--
	<noinclude>{{documentation/versioncheck}}</noinclude>		<noinclude>{{documentation/versioncheck}}</noinclude>
		+	-->

	=User Feedback=		=User Feedback=