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

UI audit screen highlighting changes #5486

Closed
MarkSiedle opened this issue Apr 17, 2019 · 5 comments

Comments

@MarkSiedle
Copy link

commented Apr 17, 2019

The enhancement

We want to make deltas in the audit screen be more discoverable. When you have a small, single-character change to something like a project variable set, it can be very difficult to spot the delta currently. If we add padding and borders, we can make this more discoverable very easily.

Mockup

The Problem:
2019-04-17 12_09_53-Microsoft Edge

The Proposed Solution:
2019-04-30 16_37_25-Audit - Octopus Deploy

Links

Internally raised by TAMs and TAM customers.

@MarkSiedle

This comment has been minimized.

@fsettele

This comment has been minimized.

Copy link

commented Apr 17, 2019

Hi Mark,

some thoughts about your proposal to make it finally right:

  • To make the audit compare better readable it would be great, that kind of the default view shows only the line(s) where the change was +-5 lines to get the context. With a click on "Show complete File" the current behavior will be restored
  • To make it easier to detect differences I would go to adapt the "git compare" format. In this case this smaller changed will be dedected faster as well
  • And finally, ensure to have a standard sorting of the audit item. I sometimes saw, that the were no actual differences, but e.g. the Variable was shown at the bottom instead of the top and so I had two differences displayed, but there was none.

Wondering what you think?

Cheers,
Franz

@MarkSiedle

This comment has been minimized.

Copy link
Author

commented Apr 26, 2019

Hi Franz (cc @fsettele),

Thanks for your thoughts here. There's been similar feedback internally about collapsing this view further, and having the ability to click "next, next, next" through each of the changes, so we'll look into that next week and see what we can come up with.

For this issue, the focus is purely on UI-updates and not making any changes to the API with regards to how the diffs are currently generated/stored on the backend (so the changes we make for this issue will work consistently with any previously-stored events).

However, we can can definitely consider a more advanced diff-engine in the future, where the output would be more similar to GitHub diffs, as you mentioned.

Regarding the variable issues you've noticed, we haven't been able to reproduce, but if you see this consistently, we'd recommend reporting that to support and our support staff can investigate further.

Cheers
Mark

@MarkSiedle MarkSiedle closed this Apr 30, 2019
@MarkSiedle MarkSiedle added this to the 2019.4.7 milestone Apr 30, 2019
@MarkSiedle

This comment has been minimized.

Copy link
Author

commented Apr 30, 2019

Release Note: UI improving delta highlighting on the audit screen

@slewis74 slewis74 modified the milestones: 2019.4.7, 2019.5.0 May 2, 2019
@lock

This comment has been minimized.

Copy link

commented Jul 31, 2019

This thread has been automatically locked since there has not been any recent activity after it was closed. If you think you've found a related issue, please contact our support team so we can triage your issue, and make sure it's handled appropriately.

@lock lock bot locked as resolved and limited conversation to collaborators Jul 31, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
3 participants
You can’t perform that action at this time.