Mercurial > hg > orthanc-book
changeset 271:1173e40cbf35
support
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 28 Aug 2019 18:18:11 +0200 |
parents | f29d75bc5c25 |
children | 07f109e3f3f7 |
files | Sphinx/source/users.rst Sphinx/source/users/support.rst |
diffstat | 2 files changed, 90 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/Sphinx/source/users.rst Sat Aug 24 10:53:13 2019 +0200 +++ b/Sphinx/source/users.rst Wed Aug 28 18:18:11 2019 +0200 @@ -13,3 +13,4 @@ users/anonymization.rst users/lua.rst users/advanced-rest.rst + users/support.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Sphinx/source/users/support.rst Wed Aug 28 18:18:11 2019 +0200 @@ -0,0 +1,89 @@ +.. _support: + +Asking for support +================== + +.. _support-resources: + +Analyzing your problem +---------------------- + +When you face a problem, you should first check out the following +resources: + +1. Make sure to :ref:`understand the basics of DICOM <dicom-guide>`. +2. Follow the :ref:`general troubleshooting guide <troubleshooting>`. +3. If the problem is related to the DICOM network protocol, follow + the :ref:`DICOM troubleshooting guide <dicom>`. +4. Have a look at **all** the :ref:`frequently asked questions (FAQs) + <faq>` that are already available in the Orthanc Book. +5. Make a search for similar problem previously discussed in the + `Orthanc Users discussion forum + <https://groups.google.com/forum/#!forum/orthanc-users>`__. +6. Check out the ``Pending changes in the mainline`` section of the + `NEWS file + <https://bitbucket.org/sjodogne/orthanc/src/default/NEWS>`__, as + your issue might already be solved in the mainline of Orthanc (i.e. + in the cutting-edge version of Orthanc since the last stable + official release). +7. Carefully read the `TODO file + <https://bitbucket.org/sjodogne/orthanc/src/default/TODO>`__ that + contains our roadmap, as you might be requesting a feature that is + currently pending in our backlog (i.e. not implemented yet). +8. Have a look for the issue in the `official bug tracker + <https://bitbucket.org/sjodogne/orthanc/issues?status=new&status=open>`__ + (click on the ``All`` button, as your issue might already been solved). + + +Importantly, for all the features that are pending in the ``TODO`` +file, if you are a company, please consider `buying professional +services <https://www.orthanc-server.com/orthanc-pro.php>`__ in order +to get the feature implemented faster. + + +.. _support-mwe: + +Discussing a minimal working example +------------------------------------ + +If none of these resources help, you can consider sending a message to +the `Orthanc Users discussion forum +<https://groups.google.com/forum/#!forum/orthanc-users>`__. In such a +situation, you **must** provide a `minimal working example +<https://en.wikipedia.org/wiki/Minimal_working_example>`__, which means that +you must provide all the following information: + +* Context and full textual description of your issue. When talking + about DICOM networking issues, carefully describe the imaging + modalities into play (including their manufacturers) and your + network topology. +* Full :ref:`configuration files <configuration>`. +* Full logs as produced by Orthanc in :ref:`verbose mode <log>`. +* Sample DICOM files. +* A sequence of command lines that lead to your problem. These command + lines must only call commands that are available as free and + open-source software and that are cross-platform (:ref:`proprietary + software does not help <proprietary>`). The most useful commands are + `cURL <https://en.wikipedia.org/wiki/CURL>`__, `DCMTK + <https://dicom.offis.de/dcmtk.php.en>`__, `dicom3tools + <https://www.dclunie.com/dicom3tools.html>`__, `dcm4che command-line + tools <https://www.dcm4che.org/>`__, or Python scripts. +* If applicable, a screenshot is worth a thousands word. +* If you report a crash, if applicable, a :ref:`core file <crash>`. + +All this information is mandatory, as it allows other members of the +Orthanc community to **reproduce your problem independently of your +setup**. If we can't reproduce your issue, we can't provide any +support! + + +.. _support-tracker: + +Using the bug tracker +--------------------- + +If you are **sure** that you are reporting a yet unknown bug, you can +consider directly introducing a `bug report on our issue tracker +<https://bitbucket.org/sjodogne/orthanc/issues/new>`__. Beware however +that your issue might be closed if too vague or if not reproducible. +As a consequence, it is advised to first use the discussion forum.