chore: adjust documentation (#198)

add docu for service account sync
add table of content to version upgrade
move iam specific docu to iam repo
add license notice and image licenses
add notice to md files in docs directory
fix typos
add notice to md files in developers directory
add check for license info headers, footers and files


---------

Refs: CPLP-3059
Co-authored-by: Evelyn Gurschler <evelyn.gurschler@bmw.de>
Reviewed-by: Evelyn Gurschler <evelyn.gurschler@bmw.de>

.github/pull_request_template.md

@@ -17,6 +17,7 @@ Please delete options that are not relevant.
 - [ ] I have followed the [contributing guidelines](https://github.com/eclipse-tractusx/portal-assets/blob/main/developer/Technical%20Documentation/Dev%20Process/How%20to%20contribute.md#commit-and-pr-guidelines)
 - [ ] I have performed [IP checks](https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-04#checking-libraries-using-the-eclipse-dash-license-tool) for added or updated 3rd party libraries
 - [ ] I have created and linked IP issues or requested their creation by a committer
+- [ ] I have added copyright and license headers, footers (for .md files) or files (for images)
 - [ ] I have performed a self-review of my own code
 - [ ] I have successfully tested my changes locally
 - [ ] I have added tests that prove my changes work

CHANGELOG.md

@@ -5,39 +5,46 @@ New features, fixed bugs, known defects and other noteworthy changes to each rel
 ## 1.7.0-RC3
 
 ### Change
-* useCase content file updated
-* images linked for traceability useCase exchanged
-* portal database upgrade documentation updated
+
+- useCase content file updated
+- images linked for traceability useCase exchanged
+- portal database upgrade documentation updated
 
 ### Feature
+
 n/a
 
 ### Bugfix
+
 n/a
 
 ## 1.7.0-RC2
 
 ### Change
-* identity provider connection documentation (developer & end user); new flow released
-* subscription management board (service provider) documentation enhanced (developer & end user)
-* updated technical user role definition
-  * removal of 'Connector User', 'App Tech User'
-  * updated 'Service Management' to 'Offer Management'
-  * added 'Semantic Model Management', 'Dataspace Discovery', 'CX Membership Info'
-  * permission assignment updated (R&R Matrix documentation & portal upgrade script provided for portal db and 
-* Interface contract documentation for 'Clearinghouse' updated with new architecture images and additional details of relevant authentication users and used endpoints
-* traceability use case page images and text sections updated for release 23.12
+
+- identity provider connection documentation (developer & end user); new flow released
+- subscription management board (service provider) documentation enhanced (developer & end user)
+- updated technical user role definition
+  - removal of 'Connector User', 'App Tech User'
+  - updated 'Service Management' to 'Offer Management'
+  - added 'Semantic Model Management', 'Dataspace Discovery', 'CX Membership Info'
+  - permission assignment updated (R&R Matrix documentation & portal upgrade script provided for portal db and
+- Interface contract documentation for 'Clearinghouse' updated with new architecture images and additional details of relevant authentication users and used endpoints
+- traceability use case page images and text sections updated for release 23.12
 
 ### Feature
+
 n/a
 
 ### Technical Support
-* Portal db - technical user upgrade script provided which need to get executed for upgrade from 1.6.0 to 1.7.0 RC
-* Keycloak db - technical user upgrade script provided which need to get executed for upgrade from 1.6.0 to 1.7.0 RC
-* Added linter rules and prettify gitHub actions for asset repo and fixed findings
+
+- Portal db - technical user upgrade script provided which need to get executed for upgrade from 1.6.0 to 1.7.0 RC
+- Keycloak db - technical user upgrade script provided which need to get executed for upgrade from 1.6.0 to 1.7.0 RC
+- Added linter rules and prettify gitHub actions for asset repo and fixed findings
 
 ### Bugfix
-* md file linkage
+
+- md file linkage
 
 ## 1.7.0-RC1
 

DEPENDENCIES

@@ -171,7 +171,7 @@ npm/npmjs/-/once/1.4.0, ISC, approved, clearlydefined
 npm/npmjs/-/onetime/5.1.2, MIT, approved, clearlydefined
 npm/npmjs/-/onetime/6.0.0, MIT, approved, clearlydefined
 npm/npmjs/-/open/9.1.0, MIT, approved, clearlydefined
-npm/npmjs/-/opener/1.5.2, MIT OR WTFPL OR (MIT AND WTFPL), approved, clearlydefined
+npm/npmjs/-/opener/1.5.2, MIT AND WTFPL AND WTFPL, approved, #11619
 npm/npmjs/-/optionator/0.9.3, MIT, approved, #9208
 npm/npmjs/-/p-limit/3.1.0, MIT, approved, clearlydefined
 npm/npmjs/-/p-locate/5.0.0, MIT, approved, clearlydefined

README.md

@@ -11,7 +11,7 @@ The Catena-X Portal application consists of
 
 ![Tag](https://img.shields.io/static/v1?label=&message=LeadingRepository&color=green&style=flat) The helm chart for installing the Catena-X Portal is available in [portal-cd](https://github.com/eclipse-tractusx/portal-cd).
 
-The Catena-X Portal is designed to work with the [Catena-X IAM](https://github.com/eclipse-tractusx/portal-iam).
+The Catena-X Portal is designed to work with the [Catena-X IAM](https://github.com/eclipse-tractusx/portal-iam) for further information you can read the [documentation](https://github.com/eclipse-tractusx/portal-iam/tree/main/docs).
 
 ## Steps to run local
 

developer/01. Onboarding/01. Invite/01. Summary.md

@@ -22,3 +22,11 @@ One email has the registration portal URL and the second email the user individu
 
 <br>
 <br>
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-assets

developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md

@@ -49,5 +49,13 @@ The endpoint does support search via the company name
 >
 > - Search field added (already available inside the table component but needs to get activated)
 > - User can add a company name (minimum 3 digits) and receives in realtime (without pressing enter) the results
-> - There is a typing validation logic implemented, if the user is not typing for 1 seconds, the serach results will show up, below 1 seconds, the system will wait if any additional characters are getting added
-> - the serach field is validating the input, only letters, spaces, "!", "?", "&", "@", ".", "\_", "-" and numbers are allowed
+> - There is a typing validation logic implemented, if the user is not typing for 1 seconds, the search results will show up, below 1 seconds, the system will wait if any additional characters are getting added
+> - the search field is validating the input, only letters, spaces, "!", "?", "&", "@", ".", "\_", "-" and numbers are allowed
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-assets

developer/01. Onboarding/01. Invite/03. Invite Company_Create Application.md

@@ -31,3 +31,11 @@ Request Body
 Please note that a standard realm config got configured inside the endpoint to ensure that all security and structural factory are considered - under following page you can find the configuration details **to be added**
 <br>
 <br>
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-assets

developer/01. Onboarding/02. Registration/01. Login.md

@@ -24,7 +24,7 @@ After selecting the company for login; the user can login via the email and pass
 <img width="600" alt="image" src="https://user-images.githubusercontent.com/94133633/217644067-91ea8590-ba4e-4c79-b4c6-7c5b7008b4f5.png">
 <br>
 
-After the successfull login; the user can directly start to proceed with the company registration form.
+After the successful login; the user can directly start to proceed with the company registration form.
 
 <br>
 <br>
@@ -36,7 +36,7 @@ Based on the fetched status; the frontend logic will decide how the user proceed
 <br>
 
 1. If the status is any status before "SUBMITTED" (< id "7"); the company registration form gets displayed; starting with the introduction screen.  
-   If company registration data have been previously added/saved already, the data will be displayed inside the registration form; otherwise an empty registration form woll be displayed.
+   If company registration data have been previously added/saved already, the data will be displayed inside the registration form; otherwise an empty registration form will be displayed.
 2. If the status is in status "SUBMITTED" (= id "7"); the information screen "application in validation" screen is getting displayed.  
    <img width="443" alt="image" src="https://user-images.githubusercontent.com/94133633/216842731-5a2097ac-240c-44fe-aa0b-8396d0474690.png">
 
@@ -50,3 +50,11 @@ Based on the fetched status; the frontend logic will decide how the user proceed
 ## Portal Login
 
 no change / update; same design as used for the registration
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-assets

developer/01. Onboarding/02. Registration/02. Add Company Data.md

@@ -57,7 +57,7 @@ Flow diagram for option a) and b)
 ```
 
 The endpoint is fetching the company data (if existing) from the bpdm data pool.
-Portal backend transfers the bpdm data pool response for the protal FE to display all relevant information. (similar structure as the portal db GET response)
+Portal backend transfers the bpdm data pool response for the portal FE to display all relevant information. (similar structure as the portal db GET response)
 
 <br>
 
@@ -103,10 +103,10 @@ Response Body
 #### b) manually entered
 
 Beside the offered autofill option via BPN, the user can also manually enter the legal company data.
-In this scenario, the bpn stays empty, since its expected that the company doesnt have a bpn yet or isnt aware about the owned bpn.
+In this scenario, the bpn stays empty, since its expected that the company doesn't have a bpn yet or isn't aware about the owned bpn.
 
 In the scenario of manually entering the data, validations (as defined below) are covered.
-Additionally to the validations, the unique identifier is getting is relevant and need to get entered by the company administrator based on the enetered legal entity country.  
+Additionally to the validations, the unique identifier is getting is relevant and need to get entered by the company administrator based on the entered legal entity country.  
 Details to the unique identifier can get found in the following section [unique identifier logic](#unique-identifier)
 
 <br>
@@ -171,7 +171,7 @@ Details to the unique identifier can get found in the following section [unique
 
 ##### Unique Identifier
 
-The company unique identifier is a company specific identifier which is used to help companies to prove their identity. In Catena-X registration party needs to add minimum one unqiue identifier which is later used inside the application verification flow to identifier the companies identity.
+The company unique identifier is a company specific identifier which is used to help companies to prove their identity. In Catena-X registration party needs to add minimum one unique identifier which is later used inside the application verification flow to identifier the companies identity.
 To support the user entry and ensure that human errors are reduced, an endpoint to fetch the allowed unique identifier (per country) as well as field input validations are implemented.
 <br>
 
@@ -256,7 +256,7 @@ no post call existing. The data will get stored as part of the POST /companyDeta
 
 ### Store/Save Company Data
 
-To store the added company data in the portal db (no matter if they have been added manually or via bpn search) the POST endpoint is triggered with the user selection of the "Confirm" button on the buttom of the form.
+To store the added company data in the portal db (no matter if they have been added manually or via bpn search) the POST endpoint is triggered with the user selection of the "Confirm" button on the bottom of the form.
 
 <br>
 
@@ -294,7 +294,7 @@ Response Body
 
 ### Display Company Data (pre-saved)
 
-In case the user has previously added company data already or used the bpn autofill option and saved the autfilled data, the registration app will display the respective company data by fetching them via the GET endpoint from the portal db
+In case the user has previously added company data already or used the bpn autofill option and saved the autofill data, the registration app will display the respective company data by fetching them via the GET endpoint from the portal db
 
 ```diff
 ! GET /api/registration/application/{applicationId}/companyDetailsWithAddress
@@ -327,3 +327,11 @@ Response Body
 
 <br>
 <br>
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-assets

developer/01. Onboarding/02. Registration/03. Add Additional Users.md

@@ -22,3 +22,11 @@ As part of the registration and onboarding process a number of users will be nee
 
 <br>
 <br>
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-assets

developer/01. Onboarding/02. Registration/04. Company Role & Consent.md

@@ -40,3 +40,11 @@ Via the endpoint post consent, the consent given by the user to the respective a
 
 <br>
 <br>
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-assets

developer/01. Onboarding/02. Registration/05. Document Upload.md

@@ -9,7 +9,7 @@
 <br>
 In Step 4, the users are asked to upload the company identification.
 <br>
-All documents uploaded under the same application register form are shown. If a second user has already uploaded a doc, the user will be able to see as well as delete this document as weel; as long as the users belong to the same company application.
+All documents uploaded under the same application register form are shown. If a second user has already uploaded a doc, the user will be able to see as well as delete this document as well; as long as the users belong to the same company application.
 <br>
 <br>
 
@@ -77,3 +77,11 @@ Uploaded documents can also get viewed / downloaded by the user. To do this, the
 
 <br>
 <br>
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-assets

developer/01. Onboarding/02. Registration/06. Verify Registration Data.md

@@ -83,3 +83,11 @@ The endpoint triggers the
 
 <br>
 <br>
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-assets

developer/01. Onboarding/02. Registration/07. Error Scenarios.md

@@ -73,7 +73,7 @@ Error scenarios:
 - Company role load unsuccessful
 - Agreement load unsuccessful
 - Agreement pre-saved data load unsuccessful
-- Agreement save unusccessfull
+- Agreement saved unsuccessfully
   - Snackbar  
      <img width="278" alt="image" src="https://user-images.githubusercontent.com/94133633/221542370-d89a44ff-dea0-4968-ad2c-96936d524452.png">
 
@@ -106,3 +106,11 @@ Error scenarios:
 
 <br>
 <br>
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-assets

developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md

@@ -186,3 +186,11 @@ The API is downloading the document which is selected by the user.<br>
 
 <br>
 <br>
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-assets