Issue Description
As an IBEX user I would like to have documentation on how the recent new alarms functionality works.
How & Where?
We recently ( #8764 & #8780) added new alarms functionality, I am currently writing the demo slides for the latest release and realised I couldn't refer scientists to our documentation for more information, because there isn't any. There needs to be an explanation in our user manual or developer manual (https://shadow.nd.rl.ac.uk/ibex_user_manual/how_to/Create-and-Manage-Configurations.html#blocks-tab is linked from the relevant menu, so may be a good place for it) of how this works to enable our users to understand what each of the checkboxes mean (e..g "latched" is not obvious at first glance). Likewise it is hard to offer support if there is not clear documentation of what expected behaviour looks like.
There is a lot of information in the tickets, so this may largely involve taking that and putting it into our manuals.
Reproducible (Yes/No)?
Search the manuals, look for associated PRs with tickets, check with reviewer
Additional Information
Documentation is good
See our Git Workflow.
Acceptance Criteria
How to Review
Before making a PR...
- Provide verbose instructions for the reviewer to test that your changes work and fix the issue
- Describe if/how you have implemented testing for this issue
- Provide screenshots of the feature to help the reviewer if relevant
If not applicable, write "Not applicable"
...
To the reviewer: Make sure to update submodules!
Issue Description
As an IBEX user I would like to have documentation on how the recent new alarms functionality works.
How & Where?
We recently ( #8764 & #8780) added new alarms functionality, I am currently writing the demo slides for the latest release and realised I couldn't refer scientists to our documentation for more information, because there isn't any. There needs to be an explanation in our user manual or developer manual (https://shadow.nd.rl.ac.uk/ibex_user_manual/how_to/Create-and-Manage-Configurations.html#blocks-tab is linked from the relevant menu, so may be a good place for it) of how this works to enable our users to understand what each of the checkboxes mean (e..g "latched" is not obvious at first glance). Likewise it is hard to offer support if there is not clear documentation of what expected behaviour looks like.
There is a lot of information in the tickets, so this may largely involve taking that and putting it into our manuals.
Reproducible (Yes/No)?
Search the manuals, look for associated PRs with tickets, check with reviewer
Additional Information
Documentation is good
See our Git Workflow.
Acceptance Criteria
How to Review
Before making a PR...
If not applicable, write "Not applicable"
To the reviewer: Make sure to update submodules!