chore: added notice suffix to markdown documentations (TRG 7.07)

eclipse-tractusx · May 20, 2024 · 5723e5a · 5723e5a
1 parent dc52763
commit 5723e5a
Show file tree

Hide file tree

Showing 33 changed files with 234 additions and 4 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -90,4 +90,4 @@ The Eclipse Foundation Board of Directors may amend this Code from time to time
 
 This Code was inspired by the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct/).
 
-[^1]: Capitalized terms used herein without definition shall have the meanings assigned to them in the Bylaws.
+[^1]: Capitalized terms used herein without definition shall have the meanings assigned to them in the Bylaws.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -55,4 +55,4 @@ https://www.eclipse.org/projects/handbook/#resources-commit
 
 Contact the project developers via the project's "dev" list.
 
-* https://accounts.eclipse.org/mailing-list/tractusx-dev
+* https://accounts.eclipse.org/mailing-list/tractusx-dev
diff --git a/INSTALL.md b/INSTALL.md
@@ -64,3 +64,11 @@ sudo vim /etc/hosts
 5. Done! The applications should be available at:
     - (frontend) `http://your-frontend-host-address.com`
     - (backend) `http://your-backend-host-address.com`
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/README.md b/README.md
@@ -41,3 +41,11 @@ Below you can find the information regarding Docker Notice for this frontend.
 
 - [Frontend](./frontend/DOCKER_NOTICE.md)
 - [Backend](./backend/DOCKER_NOTICE.md)
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/backend/INSTALL.md b/backend/INSTALL.md
@@ -55,3 +55,11 @@ helm install backend --namespace puris --create-namespace . --set ingress.enable
     - (Java & Docker) `http://YOURIP:8081/catena/swagger-ui/index.html`
     - (Kubernetes) `http://CLUSTERIP:30001/catena/swagger-ui/index.html`
 3. It is highly suggested to install and run the PURIS frontend afterward
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/backend/README.md b/backend/README.md
@@ -31,3 +31,11 @@ For details on the licensing terms, see the `LICENSE` file.
 Below you can find the information regarding Docker Notice for this frontend.
 
 [Backend](./DOCKER_NOTICE.md)
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/backend/docs/documentation.md b/backend/docs/documentation.md
diff --git a/charts/puris/README.md b/charts/puris/README.md
@@ -191,3 +191,11 @@ $ helm install puris --namespace puris --create-namespace .
 | postgresql.enabled | bool | `true` | Enable postgres by default, set to false to use existing postgres. Make sure to set backend.puris.jpa.hibernate.ddl-auto accordingly (by default database is created using hibernate ddl from backend). |
 | postgresql.fullnameOverride | string | `"backend-postgresql"` | Possibility to override the fullname |
 | postgresql.service.ports.postgresql | int | `5432` | Port of postgres database. |
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md
@@ -125,3 +125,11 @@ ocker ps
 docker exec -it {container-id} crictl rmi puris-backend:dev
 docker exec -it {container-id} crictl rmi puris-frontend:dev
 ```
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/README.md b/docs/README.md
@@ -12,3 +12,11 @@ The following table links you to the respective documentations.
 | [Administration Guide](admin/Admin_Guide.md)    | Information relevant, if you want to use the PURIS application. |
 | [Interface Documentation](api/Interface_Doc.md) | Information about the interfaces.                               |
 | [User Manual](user/User_Guide.md)               | Explanation of the views and how to use them.                   |
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/admin/Admin_Guide.md b/docs/admin/Admin_Guide.md
@@ -366,3 +366,11 @@ the chart. Optionally it may be disabled to use your own installation. Refer to
 
 Encryption at rest for databases works. It has been tested by either encrypting the docker folder or encrypting the
 whole filesystem of the machine running.
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/api/Interface_Doc.md b/docs/api/Interface_Doc.md
@@ -35,3 +35,11 @@ _Note: The port and the path depend on the configuration of the spring backend (
 
 There is a [postman collection](../../local/postman/README.md) containing
 information on how to provide master data and some basic data to test the application.
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/architecture/01_introduction_and_goals.md b/docs/architecture/01_introduction_and_goals.md
@@ -45,3 +45,11 @@ Key stakehoders for puris are:
 | Politics and Companies | more resilient supply networks              |
 | SME                    | less efforts for integration                |
 | Disposition            | Knowledge about supply and demand situation |
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/architecture/02_architecture_constraints.md b/docs/architecture/02_architecture_constraints.md
@@ -11,3 +11,11 @@ PURIS FOSS follows the following constraints:
 | Interoperability between Data Applications | Data exchange MUST follow standards so that different vendors applications may exchange data. This allows to reduce the risk of vendor-lock-ins.                                                                                                                                                                                                         |
 | Semantic Aspect Meta Model (SAMM)          | Tooling used in Catena-X to semantically describe data.                                                                                                                                                                                                                                                                                                  |
 | Digital Twins in Catena-X & Industry Core  | Standards CX-0002 and CX-0126 describe how Digital Twins following with the Asset Administration Shell shall be used. PURIS standards are built on these foundations                                                                                                                                                                                     |
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/architecture/03_system_scope_and_context.md b/docs/architecture/03_system_scope_and_context.md
@@ -80,3 +80,11 @@ the Part Type Twin as a "catalog item" representing a material that has not yet
 [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Digital%20Twin%20Kit/Adoption%20View%20Digital%20Twin%20Kit)
 describes the shared asset pattern used by puris to distribute Digital Twins between the two partners.
 For more information refer to the [concepts section](./08_concepts.md)..
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/architecture/04_solution_strategy.md b/docs/architecture/04_solution_strategy.md
@@ -29,3 +29,11 @@ PURIS FOSS
 - registers digital twins depending on the relationship of partners for a specific material
 - implements value-only submodel interfaces for information objects exchanged based on Digital Twin and Industry Core
   standards.
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/architecture/05_building_block_view.md b/docs/architecture/05_building_block_view.md
@@ -54,3 +54,11 @@ The building block view describes only the responsibilities of the components/ p
 | MAD                | Stores the partner and material related information. They may only be added via REST interfaces.                                                       |
 | Stock              | Stores and handles stock related data. It provides interfaces to create and read stock data. Also it allows to exchange stock information via the EDC. |
 | DTR                | The DTR component provides the DTR implementations to manage ShellDescriptors, query partners' DTR and consume Submodel data.                          |
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/architecture/06_runtime_view.md b/docs/architecture/06_runtime_view.md
@@ -69,3 +69,11 @@ When reloading the UI, the latest data is pulled from the backend. Whenever a pa
 is performed, then the frontend hands over the request to the backend to perform the action.
 
 Details on the Web-Ui can be found in the [User Guide](../user/User_Guide.md).
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/architecture/07_deployment_view.md b/docs/architecture/07_deployment_view.md
@@ -42,3 +42,11 @@ per partner:
 - `Connector` including `Postgres`
 
 The chart allows also to either install the database as a dependency or bring your own.
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/architecture/08_concepts.md b/docs/architecture/08_concepts.md
@@ -240,3 +240,11 @@ users. For configuration, please refer to the [Admin Guide](../admin/Admin_Guide
 _Note: The reference
 implementation [Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry)
 currently only works with one client._
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/architecture/09_architecture_decisions.md b/docs/architecture/09_architecture_decisions.md
@@ -1,3 +1,11 @@
 # Architecture Decisions
 
 _None have been documented yet._
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/architecture/10_quality_requirements.md b/docs/architecture/10_quality_requirements.md
@@ -1,3 +1,11 @@
 # Quality Requirements
 
 PURIS FOSS is compliant to the [Tractus-X Release Guidelines](https://eclipse-tractusx.github.io/docs/release).
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/architecture/11_technical_risks.md b/docs/architecture/11_technical_risks.md
@@ -4,3 +4,11 @@ This application started as a demonstrator and is enhanced to become an applicat
 debts that need to be resolved later.
 
 Until now, automated test coverage is low to medium.
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/architecture/12_glossary.md b/docs/architecture/12_glossary.md
@@ -33,3 +33,11 @@
 | Semantic Aspect Meta Model                                           | SAMM  | A formal, machine-readable semantic description (expressed with RDF/turtle) of data accessible from an Aspect. Note 1 to entry: An Aspect Model must adhere to the Semantic Aspect Meta Model (SAMM), i.e., it utilizes elements and relations defined in the Semantic Aspect Meta Model and is compliant to the validity rules defined by the Semantic Aspect Meta Model. Note 2 to entry: Aspect model are logical data models which can be used to detail a conceptual model in order to describe the semantics of runtime data related to a concept. Further, elements of an Aspect model can/should refer to terms of a standardized Business Glossary (if existing). [Source: Catena-X, CX-0002](https://catena-x.net/de/standard-library) |
 | Digital Twin                                                         | DT    | Digital representation of an asset (concept, physical device, process, etc.). Realized using the Asset Administration Shell. Used synonymously with the term "Asset Administration Shell".                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 | Managed Identity Wallet                                              | MIW   | Service providing verifieable credentials to be proof claims.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/architecture/Index.md b/docs/architecture/Index.md
@@ -13,3 +13,11 @@
 - [10. Quality Requirements](10_quality_requirements.md)
 - [11. Technical Risks](11_technical_risks.md)
 - [12. Glossary](12_glossary.md)
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/security-assessment.md b/docs/security-assessment.md
@@ -191,3 +191,11 @@ B
 | Before Mitigation | Impact: High, Likelihood: Medium, Risk: High |
 | After Mitigation | Impact: Low, Likelihood: Low, Risk: Low |
 | Mitigation | PostgreSQL DB has been implemented to the product. Status of implementation is already completed. Additionally: We don't include it in compile, but in test scope so that we have easy testing but security when deploying. |
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/docs/user/User_Guide.md b/docs/user/User_Guide.md
@@ -148,3 +148,11 @@ Per Transfer the following information is listed:
 
 _**Note**: Per data request per partner, there are two Transfers as one contracts the partner's request asset and the
 partner contracts your response asset._
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/frontend/INSTALL.md b/frontend/INSTALL.md
@@ -45,3 +45,11 @@ cd charts/puris/charts/frontend
 helm install frontend --namespace puris --create-namespace . --set ingress.enabled=true --values ../../values.yaml
 ```
 4. Done! The frontend should be available at `http://YOURIP:30000/`
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/frontend/README.md b/frontend/README.md
@@ -30,3 +30,11 @@ For details on the licensing terms, see the `LICENSE` file.
 Below you can find the information regarding Docker Notice for this frontend.
 
 [Frontend](./DOCKER_NOTICE.md)
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/frontend/docs/documentation.md b/frontend/docs/documentation.md
diff --git a/local/INSTALL.md b/local/INSTALL.md
@@ -84,3 +84,11 @@ cd local
 sh cleanup.sh
 ```
 Then start your containers again with the aforementioned commands. 
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/local/keycloak/INSTALL.md b/local/keycloak/INSTALL.md
@@ -52,3 +52,11 @@ docker volume rm kc-temp-data
 # make sure to remove the array "org.keycloak.keys.KeyProvider" (contains unneeded credentials)
 # from realm file
 ```
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris
diff --git a/local/postman/README.md b/local/postman/README.md
@@ -200,3 +200,11 @@ environment file.
 ## Run the integration test
 
 You can run the integration tests on per folder level using right click > run folder.
+
+## 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: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/puris