Merge pull request #10 from catenax-ng/release/v0.4.6

Release/v0.4.6: Documentation links fixed
eclipse-tractusx · Mar 1, 2023 · adf27a6 · adf27a6
2 parents d789b3c + 0d9fdeb
commit adf27a6
Show file tree

Hide file tree

Showing 37 changed files with 155 additions and 84 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,6 +20,13 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 
 ## [released]
 
+## [0.4.6] - 2023-03-01
+
+## Updated
+- Updated documentation, corrected links.
+
+## [released]
+
 ## [0.4.5] - 2023-02-28
 
 # Security Issues

diff --git a/DEPENDENCIES_BACKEND b/DEPENDENCIES_BACKEND
@@ -128,4 +128,4 @@ maven/mavencentral/org.springframework/spring-webflux/6.0.4, Apache-2.0, approve
 maven/mavencentral/org.springframework/spring-webmvc/6.0.4, Apache-2.0, approved, #5944
 maven/mavencentral/org.webjars/swagger-ui/4.15.5, Apache-2.0 AND MIT, approved, #5921
 maven/mavencentral/org.webjars/webjars-locator-core/0.52, MIT, approved, clearlydefined
-maven/mavencentral/org.yaml/snakeyaml/2.0, , restricted, clearlydefined
+maven/mavencentral/org.yaml/snakeyaml/2.0, Apache-2.0 AND (Apache-2.0 AND BSD-3-Clause AND EPL-1.0 AND GPL-2.0-or-later AND LGPL-2.1-or-later), restricted, #7275
diff --git a/README.md b/README.md
@@ -29,20 +29,20 @@ To get Started you can have a look into our documentation:
 
 | Name                                                                      | Description                                                                                                                                                        |
 | ----------------------------------------------------------------          | -----------------------------------------------------------------------------------------------------------------------------------------------------------        |
-| [Arc42](\docs\arc42\Arc42.md)                                             | Arc42 of Digital Product Pass                                                                                                                                      |
-| [Administration Guide](\docs\admin%20guide\Admin_Guide.md)                  | Backend documentation Product Passport App                                                                                                                         |
-| [Backend Documentation](\consumer-backend\productpass\readme.md)          | Backend documentation Product Passport App                                                                                                                         |
-| [Deployment in Hotel Budapest](\deployment\README.md)                     | Technical Guide - Deployment in ArgoCD Hotel Budapest (integration environment)                                                                                    |
-| [Docker Overview](\docker\README.md)                                      | Overview on general docker commands                                                                                                                                |
-| [Keycloak Overview](\docker\local\Keycloak\README.md)                     | This guide describes how to setup a keycloak instance in local docker container and import existing realm.json file.                                               |
-| [Short Introduction into the project](\docs\GETTING-STARTED.md)           | Battery Pass Allpication infrastructure, installation guide, technical usage guide                                                                                 |
-| [Code Scaning with Kics and Trivy](\docs\IaC.md)                          | Infrastructure As Code (IaC) with KICS intends to find security vulnerabilities by scanning the code and upload results to the security dashboard in github        |
-| [Release Guideance](\docs\RELEASE.md)                                     | Product Battery Pass Consumer App Release Guide                                                                                                                    |
-| [Secret Management](\docs\SECRETS-MANAGEMENT.md)                          | Secrets management with CX HashiCorp Vault and ArgoCD Vault Plugin (AVP) - client credentials, database passwords, access tokens                                   |
-| [Cypress Overview](\docs\cypress\CYPRESS.md)                              | Documentation for Battery Passport App E2E Cypress test                                                                                                            |
-| [End User Manual](\User%20Manual%20Product%20Viewer%20App.md)             | Enduser Manual Product Viewer App                                                                                                                                  |
-| [Postman Overview](\postman\README.md)                                    | Technical guide depicts the battery pass end-to-end API calls through the postman REST client                                                                      |
-| [Changelog](\CHANGELOG.md)                                                | Changelog                                                                                                                                                          |
+| [Arc42](./docs/arc42/Arc42.md)                                             | Arc42 of Digital Product Pass                                                                                                                                      |
+| [Administration Guide](./docs/admin%20guide/Admin_Guide.md)                  | Backend documentation Product Passport App                                                                                                                         |
+| [Backend Documentation](./consumer-backend/productpass/readme.md)          | Backend documentation Product Passport App                                                                                                                         |
+| [Deployment in Hotel Budapest](./deployment/README.md)                     | Technical Guide - Deployment in ArgoCD Hotel Budapest (integration environment)                                                                                    |
+| [Docker Overview](./docker/README.md)                                      | Overview on general docker commands                                                                                                                                |
+| [Keycloak Overview](./docker/local/Keycloak/README.md)                     | This guide describes how to setup a keycloak instance in local docker container and import existing realm.json file.                                               |
+| [Short Introduction into the project](./docs/GETTING-STARTED.md)           | Battery Pass Allpication infrastructure, installation guide, technical usage guide                                                                                 |
+| [Code Scaning with Kics and Trivy](./docs/IaC.md)                          | Infrastructure As Code (IaC) with KICS intends to find security vulnerabilities by scanning the code and upload results to the security dashboard in github        |
+| [Release Guideance](./docs/RELEASE.md)                                     | Product Battery Pass Consumer App Release Guide                                                                                                                    |
+| [Secret Management](./docs/SECRETS-MANAGEMENT.md)                          | Secrets management with CX HashiCorp Vault and ArgoCD Vault Plugin (AVP) - client credentials, database passwords, access tokens                                   |
+| [Cypress Overview](./docs/cypress/CYPRESS.md)                              | Documentation for Battery Passport App E2E Cypress test                                                                                                            |
+| [End User Manual](./docs/user%20manual/User%20Manual%20Product%20Viewer%20App.md)             | End User Manual Product Viewer App                                                                                                                                  |
+| [Postman Overview](./postman/README.md)                                    | Technical guide depicts the battery pass end-to-end API calls through the postman REST client                                                                      |
+| [Changelog](./CHANGELOG.md)                                                | Changelog                                                                                                                                                          |
 
 ### Prerequisites:
 
@@ -63,7 +63,7 @@ git clone https://github.com/eclipse-tractusx/digital-product-pass.git
 ### Install dependencies
 
 ```bash
-cd product-battery-passport-consumer-app/
+cd digital-product-pass/
 npm install --legacy-peer-deps
 ```
 
@@ -101,8 +101,6 @@ docker stop consumer-ui; docker rm consumer-ui;
 ```
 You can run the application in docker container with existing image from GitHub packages.
 
-See consumer frontend docker image in registry: [consumer-ui](https://github.com/eclipse-tractusx/digital-product-pass/pkgs/container/product-battery-passport-consumer-app%2Fconsumer-ui)
-
 ```bash
 # pull the image 
 # Replace placeholder <LATEST_TAG> with the most recent tag in registry
@@ -118,7 +116,7 @@ The consumer frontend is available in browser at [http://localhost:8080](http://
 
 ### How to set up a code editor
 
-See [VSCode configuration](https://confluence.catena-x.net/pages/viewpage.action?pageId=55009683).
+See [VSCode configuration](https://code.visualstudio.com/docs/getstarted/settings).
 
 ## License
 

diff --git a/charts/consumer-backend/Chart.yaml b/charts/consumer-backend/Chart.yaml
@@ -29,10 +29,10 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.2.4
+version: 0.2.5
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.4.5"
+appVersion: "0.4.6"
diff --git a/charts/consumer-ui/Chart.yaml b/charts/consumer-ui/Chart.yaml
@@ -29,10 +29,10 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.2.4
+version: 0.2.5
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.4.5"
+appVersion: "0.4.6"
diff --git a/deployment/README.md b/deployment/README.md
@@ -17,7 +17,7 @@
 ## Technical Guide - Deployment in ArgoCD Hotel Budapest
 
 
-> [Getting Started Documentation](getting-started.md)
+> [Getting Started Documentation](../docs/GETTING-STARTED.md)
 
 This document describes the battery pass application deployment steps in hotel budapest using helm charts. In order to deploy the app components, the following artifacts are required. 
 
@@ -27,8 +27,9 @@ This document describes the battery pass application deployment steps in hotel b
 
 - [edc-provider](./helm/edc-provider)
 
-- [consumer-ui](./helm/consumer-ui)
+- [consumer-ui](../charts/consumer-ui)
 
+- [consumer-backend](../charts/consumer-backend)
 
 #### Sign in via the GitHub account
 
@@ -40,30 +41,34 @@ Create new app from the top-left corner button.
 Fill out the following required fields.
 - **Application Name:** <APP_NAME> (e.g., materialpass-edc)
 - **Project:** project-material-pass
-- **Source:** Git repository where the application artifacts are stored (https://github.com/catenax-ng/product-battery-passport-consumer-app)
+- **Source:** Git repository where the application artifacts are stored (https://github.com/eclipse-tractusx/digital-product-pass)
 - **Revision:** select branch or a tag
-- **Path:** The path to the deployment (possible values: deployment/helm/edc-consumer, deployment/helm/edc-provider, deployment/helm/consumer-ui)
+- **Path:** The path to the deployment (possible values: deployment/helm/edc-consumer, deployment/helm/edc-provider, charts/consumer-ui, charts/consumer-backend)
 - **Cluster URL:** https://kubernetes.default.svc
 - **Namespace:** product-material-pass
 - **Plugin:** argocd-vault-plugin-helm-args
-    - set ENV as ***helm_args : --set image.tag='$ARGOCD_APP_REVISION'***
+    - Set following helm args with the corresponding application:
+        - consumer-ui: set ENV as ***helm_args = --set productpass.backend=true -f values.yaml -f values-int.yaml'***
+        - consumer-backend: set ENV as ***helm_args = -f values.yaml -f values-int.yaml'***
+        - edc-consumer: set ENV as ***helm_args = -f values-int.yaml'***
+        - edc-consumer: set ENV as ***helm_args = -f values-int.yaml'***
 
 Click on 'Create' button
 
-![Create New App](./images/create_application_with_vault_plugin.png)
+![Create New App](./images/create-app-with-vault-plugin.png)
 
 - Go inside the application and sync it. It would take some time to get synced.
 
-![Sync App](./images/app_sync.png)
+![Sync App](./images/sync-app.png)
 
-![Sync App](./images/pod_sync.png)
+![Sync App](./images/pod-sync.png)
 
 - Navigate inside the pod
 
-![Consumer Pod](./images/consumer-ui_pod.png)
+![Consumer Pod](./images/pod-consumer-ui.png)
 - Go to the logs tab
 
-![Consumer connector logs](./images/logs.png)
+![Consumer connector logs](./images/consumer-ui-logs.png)
 
 If everything works fine then the application is deployed...
 
@@ -75,18 +80,20 @@ In the end, the frontend should be accessible at https://materialpass.int.demo.c
 
 ##### Login credentails:
 - **Company Selection:** CX-Test-Access
-- **User 1:** Role: OEM, user: company 1 user, Password: changeme
+- **User 1:** Role: Dismantler, user: company 1 user, Password: changeme
 - **User 2:** Role: Recycler, user: company 2 user, Password: changeme
 
 #### Example Screenshots:
 
-![Login Page](./images/cx_login.png)
+![Company Selection Page](./images/company-selection.png)
 
-![QR Code Scanner](./images/qr_code_scanner.png)
+![Login Page](./images/login.png)
 
-![Dashboard](./images/dashboard.png)
+![QR Code Scanner](./images/qr-code-scanner.png)
 
-![Battery Passport](./images/battery_pass.png)
+![Dashboard](./images/battery-pass-dashboard.png)
+
+![Battery Passport](./images/battery-pass.png)
 
 <br />
 

diff --git a/deployment/images/app_sync.png b/deployment/images/app_sync.png
diff --git a/deployment/images/battery-pass-dashboard.png b/deployment/images/battery-pass-dashboard.png
diff --git a/deployment/images/battery-pass.png b/deployment/images/battery-pass.png
diff --git a/deployment/images/battery_pass.png b/deployment/images/battery_pass.png
diff --git a/deployment/images/company-selection.png b/deployment/images/company-selection.png
diff --git a/deployment/images/consumer-ui-logs.png b/deployment/images/consumer-ui-logs.png
diff --git a/deployment/images/consumer-ui_pod.png b/deployment/images/consumer-ui_pod.png
diff --git a/deployment/images/create-app-with-vault-plugin.png b/deployment/images/create-app-with-vault-plugin.png
diff --git a/deployment/images/create_application_with_vault_plugin.png b/deployment/images/create_application_with_vault_plugin.png
diff --git a/deployment/images/cx_login.png b/deployment/images/cx_login.png
diff --git a/deployment/images/dashboard.png b/deployment/images/dashboard.png
diff --git a/deployment/images/login.png b/deployment/images/login.png
diff --git a/deployment/images/logs.png b/deployment/images/logs.png
diff --git a/deployment/images/pod-consumer-ui.png b/deployment/images/pod-consumer-ui.png
diff --git a/deployment/images/pod-sync.png b/deployment/images/pod-sync.png
diff --git a/deployment/images/pod_sync.png b/deployment/images/pod_sync.png
diff --git a/deployment/images/qr-code-scanner.png b/deployment/images/qr-code-scanner.png
diff --git a/deployment/images/qr_code_scanner.png b/deployment/images/qr_code_scanner.png
diff --git a/deployment/images/sync-app.png b/deployment/images/sync-app.png
diff --git a/docs/RELEASE.md b/docs/RELEASE.md
@@ -21,7 +21,7 @@
 
 ## Release an application
 
-The application is released through [GitHub Releases page](https://github.com/catenax-ng/product-battery-passport-consumer-app/releases) by creating a new release and tag. Follow the [Semantic Versioning Scheme](https://semver.org/spec/v2.0.0.html) while creating a new tag.
+The application is released through [GitHub Releases page](https://github.com/eclipse-tractusx/digital-product-pass/releases) by creating a new release and tag. Follow the [Semantic Versioning Scheme](https://semver.org/spec/v2.0.0.html) while creating a new tag.
 
 
 The changelog must also be updated from [CHANGELOG.md](../CHANGELOG.md) file, showing the changes in release using [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.

diff --git a/docs/RELEASE_USER.md b/docs/RELEASE_USER.md
@@ -16,21 +16,26 @@
 
 # Release Notes Digital Product Pass Application
 
-**February 28 (initial release, version 0.4.5)**  
+
+**March 01 2023 (Version 0.4.6)**  
+*01.03.2023*
+
+### Updated
+Updated documentation issues, fixing incorrect structure.
+
+**February 28 2023 (Version 0.4.5)**  
 *28.02.2023*
 
-## Security Issues
+### Security Issues
 Updated security issues related with a library.
 
-**February 27 (initial release, version 0.4.4)**  
+**February 27 2023 (Initial Release, Version 0.4.4)**  
 *27.02.2023*
 
 Welcome to the inital release of the **Product Pass App**. Here is an overview on the applications features.
 
 Here is what's new in **Version 0.4.4:**
 
-- [Added](#added)
-
 ## Added
 
 ### Request product information