Skip to content

Commit

Permalink
Merge branch 'refs/heads/main' into feature/#832-enable-policy-manage…
Browse files Browse the repository at this point in the history
…ment

# Conflicts:
#	CHANGELOG.md
  • Loading branch information
ds-mmaul committed Jun 12, 2024
2 parents db24bc8 + bd77340 commit 3f3d861
Show file tree
Hide file tree
Showing 81 changed files with 672 additions and 117 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,15 @@ _**For better traceability add the corresponding GitHub issue number in each cha

### Changed

### Removed

- XXX Removed EdcNotifiactionMockServiceImpl class and replaced with mocks

## [11.0.2 - 29.05.2024]
### Added
- #1010 Made submodel path configurable
- #838 Added User experience > Table design section in arc42 documentation

### Changed
- #1010 Updated IRS Helm Version from 5.1.6 to 5.1.7

Expand Down
6 changes: 3 additions & 3 deletions docs/src/docs/arc42/cross-cutting/development-concepts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,12 @@ We generally follow the link:https://developers.google.com/style[Google develope
* Writing methods which provide a response to be better testable (avoid void if feasible).
* Naming of unit tests are as follows:

image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/user-guide/unit_test_naming.png[]
image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/unit_test_naming.png[]

* Use given/when/then pattern for unit test structuring.
E.g:

image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/user-guide/given_when_then_pattern.png[]
image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/given_when_then_pattern.png[]

=== Integration testing

Expand All @@ -87,7 +87,7 @@ We follow the rules and behaviour of: https://clean-code-developer.com/.

As there is no other guideline of C-X, we fix any vulnerabilities, exposures, flaw detected by one of our SAST, DAST, Pentesting tools which is higher than "Very Low".

image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/user-guide/vulnerability_level.png[]
image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/vulnerability_level.png[]

== Trace-X technical class responsibilities

Expand Down
1 change: 1 addition & 0 deletions docs/src/docs/arc42/cross-cutting/full.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ include::architecture-design-patterns.adoc[leveloffset=+1]
include::under-the-hood.adoc[leveloffset=+1]
include::development-concepts.adoc[leveloffset=+1]
include::operational-concepts.adoc[leveloffset=+1]
include::user-experience.adoc[leveloffset=+1]
1 change: 1 addition & 0 deletions docs/src/docs/arc42/cross-cutting/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@
- xref:under-the-hood.adoc["Under-the-hood" concepts]
- xref:development-concepts.adoc[Development concepts]
- xref:operational-concepts.adoc[Operational concepts]
- xref:user-experience.adoc[User experience]
118 changes: 118 additions & 0 deletions docs/src/docs/arc42/cross-cutting/user-experience.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
= User experience

== User interface

=== Table design

Trace-X uses the following table design to build consistent and user-friendly tables:

image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-design.png[]

|===
|Component |Description |Example

|Actions
a|* Black icons
* When an action cannot be executed for any reason, the icon turns grey
* A tooltip is shown when hovering over an executable action to describe it
* A tooltip is shown when hovering over a disabled action to describe the reason why it can't be executed
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-actions.png[]

|Action menus
a|* Opens when clicking on a three-dot menu
* Disappears, when clicking anywhere outside the menu
* List of action icons with text labels
* The three-dot menu is sticky when used inside the table for single-item actions
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-action-menus.png[]

|Multi-select box
a|* Clicking on it when no items are selected, selects all items on the current page
* Clicking on it when some items are selected (but not all), selects all items on the current page
* Clicking on it when all items are selected, deselects all items on the current page
* Clicking on the small arrow opens a menu for clearing the page selection or the entire selection
* The menu disappears, when clicking anywhere outside the menu
* Part of the column header row -> Sticky on top next to column headers
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-multi-select-box.png[]

|Selection box
a|* Clicking on it toggles item selection
|

|Selection count
a|* Shows selection count of the current page
|

|Column header
a|* Shows the column title
* Hovering over it shows a tooltip that describes sorting behaviour
* Clicking on it toggles sorting
* Sticky on top
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-sorting-tooltip.png[]
Ascending sorting: image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-sorting-ascending.png[]
Descending sorting: image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-sorting-descending.png[]

|Filter
a|* Can search for any string
* Results are shown directly without having to press enter
* Results are shown as a sorted list (ascending)
* Selected results are shown on top of unselected ones
* The checkbox inside the search field selects or deselects every result
* The cross inside the search field resets the search and the filter
* When the filter is active, 'All' changes to the filtered value (+ the number of other filters)
* For date values, the search is replaced with a date picker
* Sticky on top below column headers
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-filter.png[]
Date filter: image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-filter-date.png[]

|Quick filter
a|* Used to quickly filter for specific values
* Independent of regular filters
* Work exclusively - only one filter can be selected at a time
* Click on the currently active quick filter to deactivate it
|

|Table column settings
a|* Opens up as an overlay
* Clicking on Save, the cross or anywhere outside the overlay will close the overlay (only saving changes when clicking Save)
* Selecting/deselecting columns makes them visible/invisible in the table
* The order of the columns can be changed by selecting the column title and using the arrow buttons
* Using the circle arrow icon resets the column visibility and column order
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-column-settings.png[]

|Full-width toggle
a|* Used to switch between full-width mode or variable-width mode
|

|Scrollbars
a|* Only visible/active when data exceeds the visible space
* Sticky elements stay visible regardless of scroll position
|

|Page size selector
a|* Shows the currently selected page size
* When clicking on it, a dropdown opens that shows available page size options
* Clicking any option will select that option and close the dropdown
* Clicking anywhere outside the dropdown closes the dropdown without applying any changes
* Three options are always available
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-page-size-selector.png[]

|Page information
a|* Shows information about the amount of items on the current page and the total amount of items
|

|Page controls
a|* Used to switch between pages
* Controls are: First page, previous page, next page, last page
* Hovering over the controls shows a tooltip that labels each control
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-page-controls.png[]
|===

In addition, following tables are used within Trace-X:

When the data is not as complex and/or extensive and single-item actions are not needed:

image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-small.png[]

When data must only be shown and no actions are needed:

image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-data-only.png[]
Loading

0 comments on commit 3f3d861

Please sign in to comment.