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.

Sign up for GitHub

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

chore(1007): fix documentation and add example testing process #1326

Merged
merged 3 commits into from
Jul 30, 2024
Merged

chore(1007): fix documentation and add example testing process #1326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bbc81d7
chore(1007): fix documentation and add example testing process
ds-crehm Jul 29, 2024
7c7d355
chore(1007): fix policy parts diagram
ds-crehm Jul 29, 2024
5cf1597
chore(documentation): 'convert' PNG to SVG
ds-crehm Jul 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...cept/#1108-policy-management-enhancement/#1108-policy-management-enhancement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -611,7 +611,7 @@ In the frontend, it should not be possible to create multiple valid policies for
During the creation of policies, all policies that already exist must be checked.
If there is any policy that is already used for the configured BPN, the existing policy will be changed to inactive by setting the validUntil date to the currentTime.
Before doing this the user must be informed about this process and confirm it in a modal.
![notification-policy-modal.png](notification-policy-modal.png)
![notification-policy-modal.svg](notification-policy-modal.svg)

## Contract negotiation
During contract negotiation, there can only be one policy definition from Trace-X that will be compared with the catalogOffers from the receiverBPN.
Expand Down
Binary file removed docs/concept/#1108-policy-management-enhancement/notification-policy-modal.png
View file
Open in desktop
Binary file not shown.
47 changes: 47 additions & 0 deletions docs/concept/#1108-policy-management-enhancement/notification-policy-modal.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/architecture.png
View file
Open in desktop
Binary file not shown.
47 changes: 47 additions & 0 deletions docs/images/architecture.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/src/docs/arc42/cross-cutting/development-concepts.adoc
View file
Open in desktop
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/cross-cutting/unit_test_naming.png[]
image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/unit_test_naming.svg[]

* 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/cross-cutting/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.svg[]

=== 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/cross-cutting/vulnerability_level.png[]
image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/vulnerability_level.svg[]

== Trace-X technical class responsibilities

Expand Down
28 changes: 14 additions & 14 deletions docs/src/docs/arc42/cross-cutting/user-experience.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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[]
image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-design.svg[]

|===
|Component |Description |Example
Expand All @@ -16,14 +16,14 @@ 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[]
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-actions.svg[]

|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[]
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-action-menus.svg[]

|Multi-select box
a|* Clicking on it when no items are selected, selects all items on the current page
Expand All @@ -32,7 +32,7 @@ a|* Clicking on it when no items are selected, selects all items on the current
* 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[]
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-multi-select-box.svg[]

|Selection box
a|* Clicking on it toggles item selection
Expand All @@ -47,9 +47,9 @@ 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[]
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-sorting-tooltip.svg[]
Ascending sorting: image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-sorting-ascending.svg[]
Descending sorting: image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-sorting-descending.svg[]

|Filter
a|* Can search for any string
Expand All @@ -61,8 +61,8 @@ a|* Can search for any string
* 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[]
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-filter.svg[]
Date filter: image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-filter-date.svg[]

|Quick filter
a|* Used to quickly filter for specific values
Expand All @@ -77,7 +77,7 @@ a|* Opens up as an overlay
* 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[]
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-column-settings.svg[]

|Full-width toggle
a|* Used to switch between full-width mode or variable-width mode
Expand All @@ -94,7 +94,7 @@ a|* Shows the currently selected page size
* 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[]
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-page-size-selector.svg[]

|Page information
a|* Shows information about the amount of items on the current page and the total amount of items
Expand All @@ -104,15 +104,15 @@ a|* Shows information about the amount of items on the current page and the tota
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[]
|image:https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-page-controls.svg[]
|===

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[]
image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-small.svg[]

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[]
image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/arc42/cross-cutting/user-experience/table-data-only.svg[]
Loading
Loading