Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation on the alarm config editor #3201

Closed
wants to merge 3 commits into from

Conversation

georgweiss
Copy link
Collaborator

Since users were asking for how disable alarm works...

@georgweiss georgweiss requested a review from kasemir November 25, 2024 13:44
@kasemir
Copy link
Collaborator

kasemir commented Nov 25, 2024

I think the more convenient way is via the context menu in the alarm tree.
It allows you to enable/disable an item and all that's below within the hierarchy.

@georgweiss
Copy link
Collaborator Author

OK, I will add that. I assume a disable action from the context menu does not define a "disable until" date, right? Also, an import will overwrite the disable action.

@kasemir
Copy link
Collaborator

kasemir commented Nov 25, 2024

Yes on all

@georgweiss
Copy link
Collaborator Author

OK, will add some content on the context menu options.

@kasemir
Copy link
Collaborator

kasemir commented Nov 26, 2024

**NOTE 2:** An alarm configured as enabled cannot be disabled using the checkbox in the editor dialog. Instead, user needs to
 specify a disable-until date/time.

Is that true? Does the checkbox to enable/disable an alarm in the config no longer have any effect?
Are we now forced to always use disable-until-time?
That would be a bug.

@shroffk
Copy link
Member

shroffk commented Nov 26, 2024

I agree that this would be a bug.
If I remember correctly, "disable" using the check box (without the dialog) will disable the alarm until a default configured duration.
This duration can be -1 for disable forever or 3600s (default disable for 1 hour)

If this is not already the case then I can add this functionality

@georgweiss
Copy link
Collaborator Author

At this point I'm merely interested in the documentation to be able to fence off support questions.
Agree that the UI is a bit confusing as it stands. I would assume that in most cases alarms are disabled from the context menu, and not from the config dialog.

@georgweiss
Copy link
Collaborator Author

@shroffk, no need for you to step in, I can take care of the changes.
We need to agree however on the expected behavior: I suggest using the checkbox in the dialog should do the same as the context menu item. And let's also agree that "forever" actually means: until enabled or XML file imported where item is enabled.

@kasemir
Copy link
Collaborator

kasemir commented Nov 27, 2024

Yes, the checkbox in the dialog should enable/disable the channel exactly like the context menu item.
That's how it used to be before the temporary disablement, the disable-with-auto-renablement was added.
The temporary disablement option is only available via the dialog where one needs to enter a date/time.

@georgweiss
Copy link
Collaborator Author

Will fix the checkbox issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants