Skip to content

Commit

Permalink
DOC: Encourage trying preview release before reporting bug (#7686)
Browse files Browse the repository at this point in the history
* DOC: Encourage trying preview release before reporting bug

Bug reporting checklist contained a note to test with the preview release, but many users would not take the effort to actually read and follow the instructions. Therefore it may make sense to emphasize this directly in the documentation.

* DOC: Apply suggestions from code review

Co-authored-by: Jean-Christophe Fillion-Robin <jchris.fillionr@kitware.com>
Co-authored-by: Steve Pieper <pieper@isomics.com>

* DOC: Use consistent nomenclature for Slicer Stable/Preview Release

---------

Co-authored-by: Jean-Christophe Fillion-Robin <jchris.fillionr@kitware.com>
Co-authored-by: Steve Pieper <pieper@isomics.com>
  • Loading branch information
3 people committed Apr 15, 2024
1 parent 625f6e6 commit fbb7f95
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
9 changes: 8 additions & 1 deletion Docs/user_guide/get_help.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,14 @@

## I want to report a problem

If you are not sure if Slicer behaves incorrectly or you are not using it properly then [ask about it on the Slicer Forum](https://discourse.slicer.org/c/support) (in the `Support` category). If you are _sure_ that Slicer is not working as intended then [submit a bug report in the Slicer issue tracker](https://github.com/Slicer/Slicer/issues/new?assignees=&labels=type%3Abug&template=bug_report.md).
We are constantly making fixes and improvements, therefore before you report any issues:
1. Confirm the issue still exists in the current Slicer Stable Release.
2. If it still exists in the Slicer Stable Release, confirm the issue still exists in the latest Slicer Preview Release.

If you find it hard to locate answers using the search feature of the [Slicer forum](https://discourse.slicer.org) or via internet searches such as Google, try a large language model like Microsoft Copilot, OpenAI ChatGPT, Google Gemini, etc.

If you are not sure if Slicer behaves incorrectly or you are not using it properly then [ask about it on the Slicer Forum](https://discourse.slicer.org/c/support) (in the `Support` category).
If you are _sure_ that Slicer is not working as intended then [submit a bug report in the Slicer issue tracker](https://github.com/Slicer/Slicer/issues/new?assignees=&labels=type%3Abug&template=bug_report.md).

In your question/report provide all the information that is described in the [bug reporting template](https://github.com/Slicer/Slicer/blob/main/.github/ISSUE_TEMPLATE/bug_report.md#summary).

Expand Down
4 changes: 2 additions & 2 deletions Docs/user_guide/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ To download Slicer, click [here](https://download.slicer.org/).
![](https://github.com/Slicer/Slicer/releases/download/docs-resources/getting_started_download.png)

**Notes:**
- The "Preview Release" of 3D Slicer is updated daily (process starts at 11pm ET and takes few hours to complete) and represents the latest development including new features and fixes.
- The "Stable Release" is usually updated a few times a year and is more rigorously tested.
- The "Preview Release" of 3D Slicer (referred to as "Slicer Preview Release") is updated daily (process starts at 11pm ET and takes few hours to complete) and represents the latest development including new features and fixes. *Continuous* updates for extensions are not provided for preview releases: extensions that are available for a preview release are of the latest version that was available at the time when the release was created. To get updated extensions, a new preview release must be installed.
- The "Stable Release" of 3D Slicer (referred to as "Slicer Stable Release") is usually updated a few times a year and is more rigorously tested. Continuous updates for extensions are provided for the *latest* Slicer Stable Release, but not for any earlier releases. For example, if latest Slicer Stable Release is Slicer-5.2.2 and the user has Slicer-5.2.1 installed then the user will no longer receive any extension updates. To check if latest version of application and extensions are installed, you can go to `Welcome` module and in `Updates` section click `Check now` button.
- Slicer is generally simple to install on all platforms. It is possible to install multiple versions of the application on the same user account and they will not interfere with each other. If you run into mysterious problems with your installation you can try deleting the [application settings files](settings.md#settings-file-location).
- Only 64-bit Slicer installers are available to download. Developers can attempt to build 32-bit versions on their own if they need to run Slicer on a 32-bit operating system. That said, this should be carefully considered as many clinical research tasks, such as processing of large CT or MR volumetric datasets, require more memory than can be accommodated with a 32-bit program.

Expand Down

0 comments on commit fbb7f95

Please sign in to comment.