Skip to content

Commit

Permalink
fix:(README):[eclipse-tractusx#1070] change png to svg
Browse files Browse the repository at this point in the history
  • Loading branch information
mkanal committed Jul 18, 2024
1 parent d5f105d commit ff703d8
Show file tree
Hide file tree
Showing 21 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Trace-X as the Open-Source solution for Parts Traceability offers the following
A detailed guide on how to contribute can be found [here](CONTRIBUTING.md).

## Releasing
Here is our [Releasing guide](docs/RELEASE.md).
Here is our [Releasing Guide](docs/RELEASE.md).

## Frontend Application

Expand Down Expand Up @@ -132,7 +132,7 @@ $ npm install -g @angular/cli
$ yarn install
```

Start application with``yarn start`` and navigate to ``http://localhost:4200``.
Start application with ``yarn start`` and navigate to ``http://localhost:4200``.

### Application Authentication

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Source: https://miro.com/app/board/uXjVO5JVoho=/?moveToWidget=345876457235304953
- [ ] User selection of Viewer Instance is stored in User Settings. Last selected Viewer Instance will be used for next semantic model selection.
- [ ] User selected semantic model in table is highlighted in dark grey color

![DetailView_With_Code_Viewer_Active.png](DetailView_With_Code_Viewer_Active.png)
![DetailView_With_Code_Viewer_Active.png](DetailView_With_Code_Viewer_Active.svg)


### Json Code Raw Viewer
Expand All @@ -103,7 +103,7 @@ Source: https://miro.com/app/board/uXjVO5JVoho=/?moveToWidget=345876457235304953
- Vertical scrollbar
- Extend Viewer Panel is extendable to full-screen

![Detail_View_Json_Code_Viewer](Detail_View_Json_Code_Viewer.png)
![Detail_View_Json_Code_Viewer](Detail_View_Json_Code_Viewer.svg)

### Json Tree Viewer

Expand All @@ -114,18 +114,18 @@ Json Tree Viewer is the visualization of a JSON structure in a hierarchical tree
- Code Highlighting
- Line Numbering
- Extend Viewer Panel is extendable to full-screen
![Detail_View_Json_Tree_Viewer](Detail_View_Json_Tree_Viewer.png)
![Detail_View_Json_Tree_Viewer](Detail_View_Json_Tree_Viewer.svg)

### Json Graph Viewer
- Json Tree Viewer
- Json is visualized in graph view
- Code Highlighting
- Extend Viewer Panel is extendable to full-screen
![Detail_View_Json_Graph_Viewer](Detail_View_Json_Graph_Viewer.png)
![Detail_View_Json_Graph_Viewer](Detail_View_Json_Graph_Viewer.svg)


## Viewer in full-screen mode
![Viewer Full Screen](Viewer_Full_screen_mode.png)
![Viewer Full Screen](Viewer_Full_screen_mode.svg)
- Any viewer instance could be extended to full-screen mode
- Full-screen mode is disabled via X button on the right upper side.
- After closing, full-screen former detail view is shown
Expand All @@ -135,7 +135,7 @@ Json Tree Viewer is the visualization of a JSON structure in a hierarchical tree
- Viewer show initial message Semantic model cannot be displayed.
- Standard error message: Semantic model cannot be displayed. With detailed user readable message

![Error View](Error_View.png)
![Error View](Error_View.svg)

# Glossary

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The standard notification status flow must **not** be changed. The "FAILED" stat
After the notification is successfully resent, the status will be set to "SENT". Alternatively, the user can cancel the notification flow, which will set the status to "CANCELLED"/"CLOSED".

Notification status flow:
![Notification-Status-Flow.png](Notification-Status-Flow.png)
![Notification-Status-Flow.png](Notification-Status-Flow.svg)

Creating and sending notifications:
```mermaid
Expand Down Expand Up @@ -102,9 +102,9 @@ After creating and approving the notification and one of the exceptions is throw
3. A new message must be created and shown in the message history including the error description

UsagePolicyPermissionException:
![UsagePolicyPermissionException-Mockup.png](UsagePolicyPermissionException-Mockup.png)
![UsagePolicyPermissionException-Mockup.png](UsagePolicyPermissionException-Mockup.svg)
UsagePolicyExpiredException:
![UsagePolicyExpiredException-Mockup.png](UsagePolicyExpiredException-Mockup.png)
![UsagePolicyExpiredException-Mockup.png](UsagePolicyExpiredException-Mockup.svg)

# References

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ sequenceDiagram

## Sending notifications

![send-notification-policy-verification.png](send-notification-policy-verification.png)
![send-notification-policy-verification](send-notification-policy-verification.svg)

# Glossary

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
# Overview
In the frontend there are multiple versions of 'empty' values:

![example-values-frontend.png](example-values-frontend.png)
![example-values-frontend](example-values-frontend.svg)

In the backend those values are as follows:

![example-values-backend.png](example-values-backend.png)
![example-values-backend](example-values-backend.svg)

These should be consistent throughout Trace-X.

Expand All @@ -49,19 +49,19 @@ Whenever a string is saved or updated in the database and during data consumptio
### Frontend
Null values should be shown in the frontend as a dash:

![null-value-display.png](null-value-display.png)
![null-value-display](null-value-display.svg)

When sorting the values, null must be treated the default way of the database. When sorted ascending, they are at the end. When sorted descending, they are at the beginning.
Filtering for empty values must be possible. In the filter box "-" should always be shown at the top regardless of what the user is searching for.

![null-value-filter.png](null-value-filter.png)
![null-value-filter](null-value-filter.svg)

In order to reduce the amount of whitespace characters in the database, leading and trailing whitespaces should not be counted during user input.

![null-value-input-leading-and-trailing.png](null-value-input-leading-and-trailing.png)
![null-value-input-leading-and-trailing](null-value-input-leading-and-trailing.svg)
In this example, the amount of counted characters should be 10 ("blank" + " " + "test") instead of 43.

![null-value-input-only-spaces.png](null-value-input-only-spaces.png)
![null-value-input-only-spaces](null-value-input-only-spaces.svg)
Here, no characters should be counted and the input should not be accepted.

# References
Expand Down

0 comments on commit ff703d8

Please sign in to comment.