Skip to content
Snippets Groups Projects
Unverified Commit 7c2e7af6 authored by Dan Nixon's avatar Dan Nixon Committed by GitHub
Browse files

Add User Support page to dev-docs (#27537)

Add User Support page to dev-docs
parents 16f0224c d525a9d2
No related branches found
No related tags found
No related merge requests found
.. _UserSupport:
============
User Support
============
.. contents::
:local:
Introduction
############
As Mantid continues to facilitate cutting-edge scientific research, for an
increasing number of users, the support side of Mantid is growing more
and more important. This can be in many circumstances and through
different avenues; therefore, below is detailed our support procedures.
The main purpose of user support for the Mantid project, is to aide contact between the users and developers.
.. figure:: images/errorReporter.png
:class: screenshot
:width: 700px
:align: right
:alt: Error reporter
*Error reporter sends details directly to Mantid support*
Bugs and Error Reports
----------------------
1. Users can report bugs via the `Mantid Help Forum <https://forum.mantidproject.org/>`_ or the `Mantid Help Email <mantid-help@mantidproject.org>`_, or from collected **Error Reports**. Currently this is a quick first contact with the team, but doesn't give much detail about the usage or unexpected error.
2. The bug is verified and reproduced by the support team.
3. The impact and importance is assessed by the support team member by contacting the users, instrument scientists, developers or project manager as appropriate.
4. A GitHub issue to resolve the problem is created if appropriate and/or workaround tested if possible.
5. The user is contacted to give a link to the created issue and/or workaround solution, by the support team.
6. When any issue is completed naming a user, that user is contacted to let them know it will be available in the nightly build and next release. The gatekeeper that merges the fix should message the appropriate developer, to remind them to contact the original reporter. This could simply be through adding a comment while merging that points this out.
dev-docs/source/images/errorReporter.png

142 KiB

...@@ -62,6 +62,7 @@ Development Process ...@@ -62,6 +62,7 @@ Development Process
DevelopmentAndReleaseCycle DevelopmentAndReleaseCycle
Communication Communication
IssueTracking IssueTracking
UserSupport
GitWorkflow GitWorkflow
AutomatedBuildProcess AutomatedBuildProcess
JenkinsConfiguration JenkinsConfiguration
...@@ -79,6 +80,9 @@ Development Process ...@@ -79,6 +80,9 @@ Development Process
:doc:`IssueTracking` :doc:`IssueTracking`
Describes how issues are tracked over the project. Describes how issues are tracked over the project.
:doc:`UserSupport`
Procedures for User Problems to be tested and passed to the Development Team.
:doc:`GitWorkflow` :doc:`GitWorkflow`
Details the workflow used development with git and GitHub. Details the workflow used development with git and GitHub.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment