elektra icon indicating copy to clipboard operation
elektra copied to clipboard

audit module rename fields

Open notque opened this issue 2 years ago • 4 comments

Customer communicates the naming of fields not matching the actual events makes things confusing. I am not in love with all the name changes made here, but it is clearer. If you have any feedback, happy to get it.

notque avatar Sep 30 '22 18:09 notque

I would prefer the same names as defined in the CADF event: observer, target and observer also in the table header.

artherd42 avatar Oct 05 '22 16:10 artherd42

I've added what I took from the feedback. I feel like it's less clear, however it does match the CADF events now. The CADF events are less clear, so it just extends to that model. However, it's now very obvious what you're looking at. Is that an improvement?

notque avatar Oct 05 '22 18:10 notque

I agree with @notque. The labels shown in the UI don't have to exactly match the keys in the API. In fact usually the very reason why graphical users interfaces are easier for people to understand is because the labels that are displayed have been made human readable instead of using the exact technical keys. In my opinion this change doesn't make things necessarily easier to understand, especially not for people who never use the API themselves.

My suggestion would be to at least turn the TypeURI label into just Type. This is much more human-readable and I think the mental transfer from Type to TypeURI is something we can expect people who are used to the API keys to make.

edda avatar Oct 07 '22 13:10 edda

I agree TypeURI should be Type, but I would go much stronger. This is a significantly worse user experience for customers, and no change would be better than the listed change in my mind.

@edda - Are there tool tips available reasonably in our structure? Could I add Tool Tips with the event fields's actual name?

notque avatar Oct 07 '22 16:10 notque

what about this PR, is this still an issue? Or can we close it?

hgw77 avatar Feb 14 '23 12:02 hgw77

I’ll change it up to be the minimum change and we can get it in.

On Tue, Feb 14, 2023 at 5:37 AM Hans-Georg Winkler @.***> wrote:

what about this PR, is this still an issue? Or can we close it?

— Reply to this email directly, view it on GitHub https://github.com/sapcc/elektra/pull/1128#issuecomment-1429681685, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABV55CVEOHPMCI2CWQQ4UDWXN37NANCNFSM6AAAAAAQ2AWQWU . You are receiving this because you were mentioned.Message ID: @.***>

notque avatar Feb 14 '23 14:02 notque

Looking for approvals or additional feedback, thanks

notque avatar Feb 14 '23 14:02 notque