Skip to content

Commit

Permalink
chore: remove references to consortia envs (#238)
Browse files Browse the repository at this point in the history
- move images for documentation from /public/assets/images/docs to docs/static
- remove reference to consortia dev env
- remove images references to consortia dev (not available anymore) and catenax-ng from news section
- change local dev documentation for dev env removal as default
- fix directory structure for app and service release process
  • Loading branch information
evegufy authored Jan 30, 2024
1 parent 2fe8cc4 commit 3641324
Show file tree
Hide file tree
Showing 63 changed files with 56 additions and 55 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ User accounts might be companyIdP federated or CX user accounts. In both scenari

The deletion of users is audit relevant and will be audit logged inside the db.

More details to the audit logging can get found here: https://github.com/catenax-ng/tx-portal-assets/blob/945546d91065b8870aa8f69ce94b48eac7a5ade2/docs/user/Technical%20Details/Auditing.md
More details to the audit logging can get found here: [Audit Log Details](/docs/developer/Technical%20Documentation/Operations/Auditing.md)

### Own User Deletion Flow

Expand Down Expand Up @@ -44,7 +44,7 @@ More details to the audit logging can get found here: https://github.com/catenax
<br>
Delete own user account.
<br>
Important - due to the audit relevance, we dont delete directly all user related connections.
Important - due to the audit relevance, we don't delete directly all user related connections.
<br>
Instead user will get set to "DELETED", and following information/details will get deleted
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ flowchart LR
subgraph Argo CD - sync to k8s cluster
CD -- auto-sync --> A(Argo CD dev)
PICD --> A
click A "https://argo.dev.demo.catena-x.net"
end
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The portal frontend is divided into three parts
- Registration -> (/registration)
- Assets -> (/assets, /documentation)

![Schema of a local frontend environment](https://raw.githubusercontent.com/catenax-ng/tx-portal-assets/main/public/assets/images/docs/user/frontend-localhost.svg)
![Schema of a local frontend environment](https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/frontend-localhost.svg)

Each of these is running as a separate web server process. In the final deployment the Kubernetes ingress controllers redirect requests to the according servers based on URL paths. To the client the application appears as one origin, so no CORS problems arise. To run the entire frontend on your local machine follow these steps.

Expand Down Expand Up @@ -43,7 +43,10 @@ We start each part as a server process running on a different port. Then we star

With the last step the portal is fully running and there should automatically open
a browser session pointing to your local development instance at http://localhost:3000/
By default the frontend is using the backend services deployed on the public development environment.

#### Connect to backend/interface instances

To connect your local portal frontend or registration app instance against a Portal Backend, Keycloak (centralidp), Business Partner Data Management, Semantic Hub and/or Managed Identity Wallet instance, change the default environment settings (example.org) in the [portal index.html](https://github.com/eclipse-tractusx/portal-frontend/blob/main/public/index.html), or [registration index.html](https://github.com/eclipse-tractusx/portal-frontend-registration/blob/main/public/index.html) respectively, on your local accordingly (do not commit those changes, it's recommended to keep them in a local stash).

## NOTICE

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ And obviously there is no way to represent unstructured image content like photo

Some examples of different image types in different file formats and encodings:

| Example | SVG | PNG (RGB) | PNG (Indexed Color) | JPEG (95% Quality) | JPEG (30% Quality) |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Icons, Logos | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/icon.svg"/><br/>1,361 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/icon-rgb.png"/><br/>10,564 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/icon-i8.png"/><br/>1,831 bytes (8 colors) | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/icon-q95.jpg"/><br/>12,259 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/icon-q30.jpg"/><br/>4,383 bytes |
| Diagrams | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/diagram.svg"/><br/> 1,831 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/diagram-rgb.png"/><br/> 34,920 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/diagram-idx16.png"/><br/> 7,077 bytes (16 colors) | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/diagram-q95.jpg"/><br/> 21,696 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/diagram-q30.jpg"/><br/> 5,954 bytes |
| Documents | | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/document-rgb.png"/><br/> 28,603 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/document-idx12.png"/><br/> 4,138 bytes (12 colors) | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/document-q95.jpg"/><br/> 19,497 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/document-q30.jpg"/><br/> 5,884 bytes |
| Photographs | | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/photo-rgb.png"/><br/> 118,325 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/photo-idx128.png"/><br/> 24,973 bytes (128 colors) | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/photo-q95.jpg"/><br/> 38,278 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/photo-q30.jpg"/><br/> 9,102 bytes |
| Example | SVG | PNG (RGB) | PNG (Indexed Color) | JPEG (95% Quality) | JPEG (30% Quality) |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Icons, Logos | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/icon.svg"/><br/>1,361 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/icon-rgb.png"/><br/>10,564 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/icon-i8.png"/><br/>1,831 bytes (8 colors) | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/icon-q95.jpg"/><br/>12,259 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/icon-q30.jpg"/><br/>4,383 bytes |
| Diagrams | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/diagram.svg"/><br/> 1,831 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/diagram-rgb.png"/><br/> 34,920 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/diagram-idx16.png"/><br/> 7,077 bytes (16 colors) | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/diagram-q95.jpg"/><br/> 21,696 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/diagram-q30.jpg"/><br/> 5,954 bytes |
| Documents || <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/document-rgb.png"/><br/> 28,603 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/document-idx12.png"/><br/> 4,138 bytes (12 colors) | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/document-q95.jpg"/><br/> 19,497 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/document-q30.jpg"/><br/> 5,884 bytes |
| Photographs || <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/photo-rgb.png"/><br/> 118,325 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/photo-idx128.png"/><br/> 24,973 bytes (128 colors) | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/photo-q95.jpg"/><br/> 38,278 bytes | <img src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/photo-q30.jpg"/><br/> 9,102 bytes |

<br/>

Expand All @@ -88,23 +88,23 @@ Vector images like SVG will look sharp at any resolution because the image is "d

JPEG Bitmap, 30% Quality, 4x size<br/>
Extreme lossy compression results in a small file size but poor image quality with heavy artifacts.<br/>
<img width="1280px" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/diagram-q30.jpg"/>
<img width="1280px" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/diagram-q30.jpg"/>

JPEG Bitmap, 95% Quality, 4x size <br/>
A few compression artifacts especially around letters.<br/>
<img width="1280px" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/diagram-q95.jpg"/>
<img width="1280px" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/diagram-q95.jpg"/>

PNG Bitmap, indexed 16 colors, 4x size <br/>
Reducing the image to 16 colors also reduces the file size but gradients and fonts look weird.<br/>
<img width="1280px" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/diagram-idx16.png"/>
<img width="1280px" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/diagram-idx16.png"/>

PNG Bitmap, RGB, 4x size <br/>
The best bitmap quality but comes with a large file size.<br/>
<img width="1280px" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/diagram-rgb.png"/>
<img width="1280px" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/diagram-rgb.png"/>

SVG Vector, 4x size <br/>
Smallest file size and best quality.<br/>
<img width="1280px" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/diagram.svg"/>
<img width="1280px" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/diagram.svg"/>

<br/>

Expand All @@ -127,7 +127,7 @@ Images are large and often we don't want to send them over the network every tim

Follow this (SVG) decision diagram to find the optimal image encoding.

<img width="1280px" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/public/assets/images/docs/user/graphics/image-formats.svg"/>
<img width="1280px" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/graphics/image-formats.svg"/>

Choosing an image for use on a web page is a trade-off between file size and quality of display. The file format has the biggest impact on the result. High quality, high resolution bitmap images look very beautiful on the screen but often come as big files that takes very long to load. Always try to keep the file size as small as possible while preserving an acceptable quality for the user. As a rule of thumb, the file size of any image should not exceed 100kB. Whenever the image type allows to use SVG, then use SVG as it usually is the best choice combining the smallest file size together with best image quality.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -256,19 +256,19 @@ Unread first: {hostname}/api/Notification?page=0&size=15& notificationTopic=ACTI
<br>

When the user is opening the page "All" is preselected and the notification as per the endpoint:
https://portal-backend.dev.demo.catena-x.net/api/Notification?page=0&size=15&sorting=DateDesc
https://{hostname}/api/Notification?page=0&size=15&sorting=DateDesc
<br>

When the user clicks on the view tag "app only" notification as per the endpoint are showing app:
https://portal-backend.dev.demo.catena-x.net/api/Notification?page=0&size=15¬ificationTopic=OFFER&sorting=DateDesc
https://{hostname}/api/Notification?page=0&size=15¬ificationTopic=OFFER&sorting=DateDesc
<br>

When the user clicks on the view tag "info only" notification as per the endpoint are showing app:
https://portal-backend.dev.demo.catena-x.net/api/Notification?page=0&size=15¬ificationTopic=INFO&sorting=DateDesc
https://{hostname}/api/Notification?page=0&size=15¬ificationTopic=INFO&sorting=DateDesc
<br>

When the user clicks on the view tag "messaged with action required" notification as per the endpoint are showing app:
https://portal-backend.dev.demo.catena-x.net/api/Notification?page=0&size=15&onlyDueDate=true&sorting=DateDesc
https://{hostname}/api/Notification?page=0&size=15&onlyDueDate=true&sorting=DateDesc

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ in order to request a push of data:

```
{
"callbackUrl":"https://portal-backend.dev.demo.catena-x.net/api/administration/registration/clearinghouse",
"callbackUrl":"https://portal-backend.{env}.example.org/api/administration/registration/clearinghouse",
"participantDetails":{
"name":"SmokeTest CH",
"city":"Stuttgart",
Expand Down
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
6 changes: 3 additions & 3 deletions docs/user/04. App(s)/02. App Release Process/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ and click on

- [Step 1: App Card](./01.%20App%20Card.md)
- [Step 2: App Detail Page](./02.%20App%20Detail%20Page.md)
- [Step 3: Terms & Conditions](./03.Terms%26Conditions.md)
- [Step 4: Technical Integration](./04.Technical%20Integration.md)
- [Step 5: Verify & Submit](./05.Verify%20%26%20Submit.md)
- [Step 3: Terms & Conditions](./03.%20Terms%26Conditions.md)
- [Step 4: Technical Integration](./04.%20Technical%20Integration.md)
- [Step 5: Verify & Submit](./05.%20Verify%20%26%20Submit.md)
- [App Design Guidelines](./App-Design_guidelines.md)
- [App Release Guidelines](./App-Release_guidelines.md)

Expand Down
6 changes: 3 additions & 3 deletions docs/user/05. Service(s)/02. Service Release Process/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ and click on the action button "Register your service"

- [Step 1: Service Card](./01.%20Service%20Card.md)
- [Step 2: Service Detail Page](./02.%20Service%20Detail%20Page.md)
- [Step 3: Terms & Conditions](./03.Terms%26Conditions.md)
- [Step 4: Technical Integration](./04.Technical%20Integration.md)
- [Step 5: Verify & Submit](./05.Verify%20%26%20Submit.md)
- [Step 3: Terms & Conditions](./03.%20Terms%26Conditions.md)
- [Step 4: Technical Integration](./04.%20Technical%20Integration.md)
- [Step 5: Verify & Submit](./05.%20Verify%20%26%20Submit.md)
- [FAQ](./06.%20FAQ.md)

<br>
Expand Down
18 changes: 3 additions & 15 deletions public/assets/api/news/latest.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,34 +5,22 @@
"subtitle": "Catena-X",
"description": "With March 2023 - the new EDC Version 0.3.x will be available and is to be used for upcoming 3.1 e2e tests",
"readMoreText": "Get Change Details",
"readMoreLink": "https://github.com/catenax-ng/product-edc/blob/develop/CHANGELOG.md#030---2023-02-20",
"image": {
"src": "https://portal.dev.demo.catena-x.net/assets/images/samples/s006.jpg",
"alt": "EDC New Version"
}
"readMoreLink": "https://github.com/eclipse-tractusx/tractusx-edc/blob/main/CHANGELOG.md#030---2023-02-20"
},
{
"id": "2",
"title": "Test of Release 3.1 starting on 03rd of April",
"subtitle": "Catena-X",
"description": "Next round of e2e Test is starting soon. Contact the Test Management to get part of it",
"readMoreText": "",
"readMoreLink": "",
"image": {
"src": "https://portal.dev.demo.catena-x.net/assets/images/samples/s006.jpg",
"alt": "BMW New Stuff"
}
"readMoreLink": ""
},
{
"id": "3",
"title": "Lorem ipsum",
"subtitle": "Catena-X",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt",
"readMoreText": "Read more",
"readMoreLink": "#",
"image": {
"src": "https://portal.dev.demo.catena-x.net/assets/images/samples/s006.jpg",
"alt": "BMW New Stuff"
}
"readMoreLink": "#"
}
]
Binary file removed public/assets/images/docs/company-ssi-database.png
Binary file not shown.
Binary file removed public/assets/images/docs/use-case-database.png
Binary file not shown.
Loading

0 comments on commit 3641324

Please sign in to comment.