Skip to content

Commit 75b6548

Browse files
committed
chore(docs):[#511] cleanup and unify installation instructions in INSTALL.md
1 parent 4f75b50 commit 75b6548

File tree

4 files changed

+34
-252
lines changed

4 files changed

+34
-252
lines changed

INSTALL.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,38 @@
11
# Installation Instructions
22

3+
## Installation Instructions Helm
4+
5+
### Install Helm chart from the Helm chart repository
6+
7+
```
8+
# 1. Add the helm chart repository:
9+
helm repo add tractusx-dev https://eclipse-tractusx.github.io/
10+
```
11+
12+
```
13+
# 2. Install traceability-foss chart into your cluster:
14+
helm install traceability-foss tractusx-dev/traceability-foss
15+
```
16+
### Use Helm chart as dependency on your own Helm chart
17+
18+
```
19+
dependencies:
20+
- name: traceability-foss
21+
repository: https://eclipse-tractusx.github.io/traceability-foss
22+
version: 1.x.x
23+
```
24+
25+
### Configure product-example Helm chart on your needs
26+
27+
Please have a look into our [Helm chart documentation](charts/traceability-foss/README.md) for more information about the configuration options.
28+
329
## Installation Instructions Frontend
430

5-
- [Installation Instructions Frontend](frontend/INSTALL.md)
31+
To run the frontend locally with a already existing backend, use the run configs in [frontend/package.json](frontend/package.json).
632

7-
## Installation Instructions Backend
33+
Add a run config by creating a new entry in [package.json](frontend/package.json) similar to `"start:auth": "ng serve --configuration=dev,auth"` and adding a entry in [angular.json](frontend/angular.json) at "projects.trace-x.architect.build.configuratns" and "projects.trace-x.architect.serve.configurations".
834

9-
- [Installation Instructions Backend](tx-backend/INSTALL.md)
35+
Add an environment by creating new file in [frontend/src/environments](frontend/src/environments) and reference it in the [package.json](frontend/package.json) build configuration.
1036

1137
## Installation Instructions Local Umbrella
1238

@@ -56,8 +82,6 @@ helm install umbrella charts/umbrella/ -n umbrella --create-namespace -f charts/
5682

5783
### Local Frontend with Umbrella Trace-X backend
5884

59-
To use the frontend locally, follow the [installation instructions](frontend/INSTALL.md).
60-
6185
To integrate with the umbrella services, run the frontend with `start:auth:localUmbrella`
6286

6387
Afterward, use one of the following users to log into the CX-Operator realm:
@@ -71,4 +95,4 @@ Afterward, use one of the following users to log into the CX-Operator realm:
7195
### Out of scope
7296

7397
- Sending notifications is currently not supported
74-
- IRS Asset Sync requires a new release of IRS which provides a fix for callback url validation
98+
- IRS Asset Sync does not yet work with IRS 5.4.0. It requires a new release of IRS which provides a fix for callback url validation.

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,10 @@ Trace-X as the Open-Source solution for Parts Traceability offers the following
7878
* Quality Investigations (Company to Supplier)
7979
* Quality Alerts (Company to Customers)
8080

81+
## Installation
82+
83+
* see [Installation guide](INSTALL.md)
84+
8185
## How to contribute
8286

8387
A detailed guide on how to contribute can be found [here](CONTRIBUTING.md).
@@ -111,10 +115,6 @@ Because it uses SVGs, we knew it will perform great. And we are able to have pin
111115
* [Angular CLI](https://angular.io/cli)
112116
* [YARN](https://yarnpkg.com/)
113117

114-
### Frontend Installation
115-
116-
* see [Installation guide](frontend/INSTALL.md)
117-
118118
### Getting started
119119

120120
Clone the source locally:
@@ -158,10 +158,6 @@ See [Testing](frontend/TESTING.md).
158158
* JDK 21
159159
* [Docker Engine](https://docs.docker.com/engine/)
160160

161-
### Backend Installation
162-
163-
* see [Installation guide](tx-backend/INSTALL.md)
164-
165161
### Backend Testing Strategy
166162
See [Testing](tx-backend/TESTING.md).
167163

frontend/INSTALL.md

Lines changed: 0 additions & 145 deletions
This file was deleted.

tx-backend/INSTALL.md

Lines changed: 0 additions & 93 deletions
This file was deleted.

0 commit comments

Comments
 (0)