Skip to content

Commit

Permalink
new manual entry on how to report an issue in Redmine
Browse files Browse the repository at this point in the history
  • Loading branch information
NinaBrundke committed Jan 7, 2025
1 parent 665a469 commit 472137e
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 4 deletions.
Binary file added openatlas/static/manual/_images/redmine_form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
94 changes: 90 additions & 4 deletions sphinx/source/examples/report_issue.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,93 @@ works smoothly again.
The easiest way to report such a problem is via
`OpenAtlas Redmine <https://redmine.openatlas.eu/projects/uni>`_.

How to report
-------------
To report an issue, an account must first be created. This is of course completely free and all you need is a valid email address and a password.
Activation is not automatic, but is carried out manually by the OpenAtlas team. This may take some time. Therefore, it might be best to create an account before it is needed to report bugs
Besides reporting bugs in that way you can also request a new feature or ask a
question.

How to report an issue
----------------------

Get a redmine account
*********************
To report an issue, an account must first be created. This is - of course -
completely free of charge and all you need is a valid email address and a
password.
Activation is not automatic, but is carried out manually by the OpenAtlas team.
This may take some time. Therefore, it might be best to create an account
before it is needed to report bugs.

Create a new issue
***************
Once you are logged in, click the **Projects** link in the top left.

.. image:: redmine_projects.png
:width: 400px

Then click on OpenAtlas or OpenAtlas Discovery (depending on where the issue
occurred). This will bring you to the overview page. On the top left you can
find a **+ Button**. Hover over it with the mouse and select
**New issue** which brings you to an empty form.


Fill out the form
*****************
**Don't be alarmed**, reporting bugs in Redmine is easy and uncomplicated even
if the form asks for many details - we only ask you to fill in few
information. Everything else will be taken care of by the OpenAtlas team.

.. image:: redmine_form.png
:width: 400px

There are only two important form fields:

* **Subject** - please give a descriptive name for the issue you are reporting
(similar to e.g. the subject of an email)
* **Description** - please describe the issue you want to import. What happened
and where in the OpenAtlas instance did it happen. If possible, we kindly
ask you to provide a **link** to where you found the problem. This makes it
easier for us to find and resolve the issue for you.

All other fields are optional for you to fill out. But keep in mind that a
screenshot of the issue (can be added at the end of the form via the Browse
button) can facilitate our work. Other optional form fields:

* Project - provides a list of projects. You can pick from the drop down
list in which project the issue happened
* Tracker - there are four different types of issues you can report:

* Bug: Report an error
* Features: Request a new feature such as a new function
* Question: Use to ask a question
* Administration: Use for administrative tasks such as server upgrades or
planning an event

* Status - please leave status on new if it is not yours to work on

* New: A new issue
* Acknowledged: The issue has been recognized and accepted
* Assigned: Someone was assigned to work on it
* In progress: Someone is actively working on the issue
* Resolved: The issue has been dealt with but is not fully resolved yet -
some more testing, etc. might be needed
* Closed: The issue has been resolved
* Rejected: The issue was rejected and an explanation was given
* Duplicate: The issue was already reported

* Priority - not in use within the OpenAtlas Redmine. The priority of issues
is determined through their placement in the roadmap
* Assignee - please only choose yourself as assignee or leave it blank
* Target version - please leave blank. It is only needed for internal
project planning
* Found in version: Only available for bugs, you can fill in the version
number of your instance (can be found in the upper right corner of your
OpenAtlas instance page)

Afterwards you can press **Create** to save and send the issue to us or press
**Create and add another** to save the issue and start a new issue form
immediately.
Planned future releases with corresponding issues can be viewed on the
`OpenAtlas roadmap <https://redmine.openatlas.eu/projects/uni/roadmap>`_.
Please note that the development of OpenAtlas is a fluid process and
planned releases of new features might change.


0 comments on commit 472137e

Please sign in to comment.