With the severity levels added to the compliance report, there is no one place users can visit to see what types of violations can be produced and the severity level that they are attributed to.
@aregnery The proposal seems to indicate creating an actual reference table to view all possible severity levels in one place, is this the case?
I ask because the vision in &5237 (closed) indicates that we display severity as an additional table column, but I'm not sure if this issue or #299359 (closed) covers this, or if we need an additional issue to actually track the addition of said table column.
@dennis my assumption was that a reference table would need to be created (scope of this issue), and if we need to create another issue to add a column to the UI then that makes sense to me
@aregnery would this reference table live in the UI somewhere near the Compliance Report? Or would it live elsewhere, such as the documentation for this feature?
if we need to create another issue to add a column to the UI then that makes sense to me
I was looking for confirmation on whether this requirement was scoped in an existing issue, but it sounds like a new one has to be created.
@dennis ah fair point. Edited my comment. The table shown in this issue is more for illustrative purposes because its hard to show every condition in a mockup. I assumed this would live somewhere in the database, and/or be added to the documentation.
Thanks for clarifying @aregnery! I've gone ahead and added the scope of adding the new table column to this issue. If the team feels we need to separate it during planning breakdown we can certainly do so!
This feature issue does not have the documentation label.
Please add it if appropriate, because documentation is one of the aspects of our MR acceptance checklist.
@susantacker I'm working on this right now in !82804 (merged). I'm not sure what you mean about the second column? If you could point it out in the MR that would be really helpful
Apologies, @rob.hunt! In the table below, the second column, "Severity rating", duplicates the info already in the icon.
Icon
Severity rating
Critical
High
Medium
Low
Info
You could do this instead, getting rid of the table, if you want to list them:
Severity rating icons:
You could even get rid of the bullets.
It might seem nitpicky, but we are always looking for ways to provide great information but also cut down on verbiage. The docs site is growing fast and we want people to be able to focus on the most important info they need.
Ahh, I see what you mean! In this, I would personally disagree @susantacker. The text is there to explain what the icons mean. I don't think these icons are synonymous with severity levels in users' minds so just displaying the icons doesn't provide any real level of context for them. Additionally, although the color is there for users to see, if a user is colorblind or otherwise visually impaired, I think listing out the levels as text would really help.
Of course, I'm not a UX expert, so I might be well off the mark and I'm okay with a general consensus being that the text is unnecessary . If that is the case, I would suggest rejigging it so the icon list is removed and we add them to the violation types table instead.
I'm going to mark this as closed now we have this first iteration out. Happy for us to create a follow-up issue if anyone feels strongly about changing the way we've structured the content