Consolidate event class configuration

Class info is now separated in numerous places - inspector class assignment
configuration, two macros in templates, webpage It would be nice to have at
least some of the class related info consolidated.

Let's start with configurable folder, within which subfolders (named by
class label) would hold most of the data concerning one class.

• JSON for basic info - description for reporter, web reference, maybe severity
• Babel translations subfolder (we're ok with need for Apache/Flask reload on changes)
• Related Jinja templates/macros for reporter (txt and html)

Later (in following issues) we might address coupling with inspector rules,
templates/coupling with other places of Hawat (like Events search), and/or
consolidation of wiki information.

assigned to @jan_zerdik

By Pavel Kácha on 2024-12-26T14:06:47

added C-Dev-Core Done 0% P4 S-New T-Feature labels

changed milestone to %Backlog

Back Relation 'relates' from: 5752

Relation 'relates' to: 6127

Relation Relates - Feature 5752 Reporting based on event class knowledge

By Pavel Kácha on 2019-08-29T11:51:52

About translations for every class in special subfolder vs one translation for all classes in one folder.
Every class separatly pros:

• no need to change installed files with adding own class (compiled mo files)

One subfolder pros:

• macros will probably very similar, so there won't be duplicates in many subfolders
• easier code (doesn't really matter, I have nearly finished version with seperated subfolders)

Opinions?

By Jan Žerdík on 2019-09-16T12:09:07

Another for one subfolder:

• for every class we have just label to translate, maybe will have reference (all links are to czech description without english counterpart) in future, so nearly all classes have just one line in translations

By Jan Žerdík on 2019-09-16T12:15:33

Jan Žerdík wrote:

One subfolder pros:

• macros will probably very similar, so there won't be duplicates in many subfolders

Macros cannot be defined once and included/referenced to avoid duplicates?

By Pavel Kácha on 2019-09-23T12:50:55

Just sidenote: on the first glance there is a typo "deault" instead of "default" on a couple of places.

By Pavel Kácha on 2019-09-23T12:58:47

@ph wrote:

Jan Žerdík wrote:

One subfolder pros:

• macros will probably very similar, so there won't be duplicates in many subfolders

Macros cannot be defined once and included/referenced to avoid duplicates?

Yes, they can, but I meant duplicates of strings in translation files. Columns like count, ip, url and alike will be in nearly all macros even when the rest of macro will be different.

By Jan Žerdík on 2019-09-23T13:00:47

@ph wrote:

Just sidenote: on the first glance there is a typo "deault" instead of "default" on a couple of places.

Thank you, fixed.

By Jan Žerdík on 2019-09-23T13:15:43

I'd say let's go with what you have already done (separate translations), unless Mek raises his opinion soon.

By Pavel Kácha on 2019-09-24T12:11:42

I like this approach. Please continue and let me know, when you are ready to deploy your code to development server for testing.

By Jan Mach on 2019-09-24T13:13:49

added S-In Progress label and removed S-New label

changed milestone to %2.6

I sent rest of the stuff that we spoke about, so if nobody find any problem, I consider it ready for test.

By Jan Žerdík on 2019-10-02T14:03:54

Looks very well.

Let's make popup bubbles with longer description of column headers.

Also, it it's not too convoluted, let's try feedback as Bootstrap modal, so we are left with plain table, consistently skinnable as the rest of Hawat.

By Pavel Kácha on 2019-11-21T12:11:13

What is the status of this issue, do you consider it production ready? We should discuss this on our next meeting. If you are happy with the test results, we could consider it done and proceed to release next version.

By Jan Mach on 2020-01-28T09:17:51

added Done 100% S-Feedback labels and removed Done 0% S-In Progress labels

@Jan_Mach wrote:

What is the status of this issue, do you consider it production ready? We should discuss this on our next meeting. If you are happy with the test results, we could consider it done and proceed to release next version.

If nobody has any more requirements and you didn't find any problems than it is ready.

By Jan Žerdík on 2020-01-28T09:25:52

Relation Relates - Task 6127 Document procedures for adding new event class

By Pavel Kácha on 2020-01-29T09:04:28

(Note to prevent wrong impression: docs is not a requirement for rolling working code to production in my opinion.)

By Pavel Kácha on 2020-01-29T09:11:08

added S-Closed label and removed S-Feedback label

closed