diff --git a/README.md b/README.md index 5179a733..c8d229d7 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Beside the dependencies provided in the Helm Chart, the following dependencies h ### Data Sovereignty Currently, edc assets are always configured to match exactly one kind policy. These policies can be defined during -deployment (see [Admin Guide](./docs/adminGuide/Admin_Guide.md)). Data is offered to each partner, who has been added to +deployment (see [Admin Guide](docs/admin/Admin_Guide.md)). Data is offered to each partner, who has been added to the PURIS FOSS's master data pool depending on the business relationship (partner is a customer / supplier). For productive use, the following features should be implemented: diff --git a/docs/README.md b/docs/README.md index 3f107abd..c867c0ab 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,14 +1,14 @@ # Introduction -This repository provides the frontend and backend of the puris demonstrator. +This repository provides the frontend and backend of the puris demonstrator. It allows to exchange data according to puris related standards to fulfill short-term information needs. The following table links you to the respective documentations. -| Documentation | Purpose | -|------------------------------------------------------------|-----------------------------------------------------------------| -| [Arc42](./arc42/Index.md) | Architecture Documentation of Frontend and Backend. | -| [DEVELOPMENT.MD](./DEVELOPMENT.md) | Information relevant, if you contribute in PURIS development. | -| [Administration Guide](./adminGuide/Admin_Guide.md) | Information relevant, if you want to use the PURIS application. | -| [Interface Documentation](./interfaceDoc/Interface_Doc.md) | Information about the interfaces. | -| [User Manual](./userGuide/User_Guide.md) | Explanation of the views and how to use them. | +| Documentation | Purpose | +|-------------------------------------------------|-----------------------------------------------------------------| +| [Arc42](architecture/Index.md) | Architecture Documentation of Frontend and Backend. | +| [DEVELOPMENT.MD](./DEVELOPMENT.md) | Information relevant, if you contribute in PURIS development. | +| [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. | diff --git a/docs/adminGuide/Admin_Guide.md b/docs/admin/Admin_Guide.md similarity index 98% rename from docs/adminGuide/Admin_Guide.md rename to docs/admin/Admin_Guide.md index 1a02442f..ea7cf71b 100644 --- a/docs/adminGuide/Admin_Guide.md +++ b/docs/admin/Admin_Guide.md @@ -108,7 +108,7 @@ _Note: The application does NOT make use of the `Client Authentication` (private ## Data Sovereignty related configuration With R24.05, always Framework Agreement and Usage Purpose Contract Policies need to be used. Refer to -[ARC42 - Chapter 8](../arc42/08_concepts.md) for the influence of these configurations. +[ARC42 - Chapter 8](../architecture/08_concepts.md) for the influence of these configurations. TLDR; you define the definition of the policy you want to use and that you'll accept. PURIS FOSS only handles one policy that is templated. You can only configure the name and version of the Framework Agreement Credential and the Usage Purpose. @@ -116,7 +116,8 @@ Purpose. ### Framework Agreement To configure the Framework Agreement credential, that is automatically enforced by the EDC during contracting -(see further details in [ARC42 - Chapter 8](../arc42/08_concepts.md)), the following properties need to be configured. +(see further details in [ARC42 - Chapter 8](../architecture/08_concepts.md)), the following properties need to be +configured. The table contains the puris defaults for release R24.05. @@ -136,7 +137,7 @@ the [Portal's documentation on how to sign use case agreements](https://github.c ### Usage Purpose To configure the Usage Purpose under which the assets may be used (see further details -in [ARC42 - Chapter 8](../arc42/08_concepts.md)), +in [ARC42 - Chapter 8](../architecture/08_concepts.md)), the following properties need to be configured. The table contains the puris defaults for release R24.05. | Helm | Docker | Configuration | @@ -338,7 +339,7 @@ Material entity. **ATTENTION:** please wait some time after updating master data prior to create or update operational data because the Twins are registered asynchronously when creating / updating material partner relationships (see -[runtime view](../arc42/06_runtime_view.md) for more details). +[runtime view](../architecture/06_runtime_view.md) for more details). ### Onboard operational data diff --git a/docs/interfaceDoc/Interface_Doc.md b/docs/api/Interface_Doc.md similarity index 76% rename from docs/interfaceDoc/Interface_Doc.md rename to docs/api/Interface_Doc.md index 6332c824..b0084d61 100644 --- a/docs/interfaceDoc/Interface_Doc.md +++ b/docs/api/Interface_Doc.md @@ -5,10 +5,10 @@ documentations. ## Overview of Data Exchange Interfaces -The [arc42 documentation](../arc42/Index.md) provides an overview based on the following chapters: +The [arc42 documentation](../architecture/Index.md) provides an overview based on the following chapters: -- [Building Block View](../arc42/05_building_block_view.md) shows which kind of interfaces are present -- [Runtime View](../arc42/06_runtime_view.md) shows how data with participants is exchanged (implementation of +- [Building Block View](../architecture/05_building_block_view.md) shows which kind of interfaces are present +- [Runtime View](../architecture/06_runtime_view.md) shows how data with participants is exchanged (implementation of standardization candidate) ## Swagger documentation diff --git a/docs/arc42/img/06-twin-creation.svg b/docs/arc42/img/06-twin-creation.svg deleted file mode 100644 index 5938a55a..00000000 --- a/docs/arc42/img/06-twin-creation.svg +++ /dev/null @@ -1 +0,0 @@ -PURIS backendMaterialControllerMaterialControllerMaterialPartnerRelationsControllerMaterialPartnerRelationsControllerMaterialServiceImplMaterialServiceImplMaterialPartnerRelationServiceImplMaterialPartnerRelationServiceImplEdcAdapterServiceEdcAdapterServiceDtrAdapterServiceDtrAdapterServiceCreate or Update Material or Product1Create or Update Material or Productalt[create material or product]2Generate or takeCatena-X ID(save on material)3OK4Create or Updae MPR for partnerand material / product5Create DtrRegistrationTask6Determine Partners whobuy material and supply productDtrRegistrationTaskalt[at least one Partner who buys (We're the supplier)]7Create ShellDescriptor with access rights for buyingpartners and all submodels8OK[at least one Partner who sells (We're the customer)]alt[MPR does not yet have the CX-ID]9Lookup DigitalTwin at Supplierto extract Catena-X ID10Lookup and Contract DTR11Determine ShellDescriptor andSubmodel "DSP" Endpoint forPartTypeInformation frompartner DTR12Query PartTypeInformation Submodelat partner13Extract Catena-X ID from Submodel14Catena-X ID15Set Partner Catena-X ID16Save MaterialPartnerRelationship17Create or Update ShellDescriptor with access rights for sellingpartners and all submodels18OK19OK \ No newline at end of file diff --git a/docs/arc42/01_introduction_and_goals.md b/docs/architecture/01_introduction_and_goals.md similarity index 100% rename from docs/arc42/01_introduction_and_goals.md rename to docs/architecture/01_introduction_and_goals.md diff --git a/docs/arc42/02_architecture_constraints.md b/docs/architecture/02_architecture_constraints.md similarity index 100% rename from docs/arc42/02_architecture_constraints.md rename to docs/architecture/02_architecture_constraints.md diff --git a/docs/arc42/03_system_scope_and_context.md b/docs/architecture/03_system_scope_and_context.md similarity index 100% rename from docs/arc42/03_system_scope_and_context.md rename to docs/architecture/03_system_scope_and_context.md diff --git a/docs/arc42/04_solution_strategy.md b/docs/architecture/04_solution_strategy.md similarity index 100% rename from docs/arc42/04_solution_strategy.md rename to docs/architecture/04_solution_strategy.md diff --git a/docs/arc42/05_building_block_view.md b/docs/architecture/05_building_block_view.md similarity index 100% rename from docs/arc42/05_building_block_view.md rename to docs/architecture/05_building_block_view.md diff --git a/docs/arc42/06_runtime_view.md b/docs/architecture/06_runtime_view.md similarity index 95% rename from docs/arc42/06_runtime_view.md rename to docs/architecture/06_runtime_view.md index 023beaf7..8c7dcb42 100644 --- a/docs/arc42/06_runtime_view.md +++ b/docs/architecture/06_runtime_view.md @@ -38,7 +38,7 @@ Roughly said the following steps need to be achieved to lookup a Submodel Y for 2. Catalog query filters by `assetId` extracted from `SubmodelDescriptor` 3. Prior to usage the catalog offers are filtered for an offer your application supports: PURIS FOSS only allows policies with Exactly one `FrameworkAgreement` and one `UsagePurpose`. It only accepts the - same Policy it offers (see [Admin Guide](../adminGuide/Admin_Guide.md)) + same Policy it offers (see [Admin Guide](../admin/Admin_Guide.md)) 4. Query `Submodel Y` trough `EDC` 5. Terminate Transfer for `Submodel Y` @@ -68,4 +68,4 @@ as soon as a MaterialPartnerRelation is changed. The Digital Twin is always recr When reloading the UI, the latest data is pulled from the backend. Whenever a partner-related update on the information 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](../userGuide/User_Guide.md). +Details on the Web-Ui can be found in the [User Guide](../user/User_Guide.md). diff --git a/docs/arc42/07_deployment_view.md b/docs/architecture/07_deployment_view.md similarity index 100% rename from docs/arc42/07_deployment_view.md rename to docs/architecture/07_deployment_view.md diff --git a/docs/arc42/08_concepts.md b/docs/architecture/08_concepts.md similarity index 97% rename from docs/arc42/08_concepts.md rename to docs/architecture/08_concepts.md index 9bf25497..ee9900da 100644 --- a/docs/arc42/08_concepts.md +++ b/docs/architecture/08_concepts.md @@ -43,7 +43,7 @@ Following the standard, the following measures have been taken: - Access Policies and Access Restrictions - Contract Policies - Consumer Side Validation -- Views in Frontend (admin access, see [User Guide](../userGuide/User_Guide.md), not handled in this chapter) to +- Views in Frontend (admin access, see [User Guide](../user/User_Guide.md), not handled in this chapter) to overview negotiations and transfers. ### Access Policies and Access Restrictions @@ -165,7 +165,7 @@ Example for Submodels based on following configurations: } ``` -_Note: see configuration of usage policies in [AdminGuide](../adminGuide/Admin_Guide.md)._ +_Note: see configuration of usage policies in [AdminGuide](../admin/Admin_Guide.md)._ ### Consumer Side Validation @@ -220,7 +220,7 @@ contract offer for the partner's BPNL. ## Security Backend APIs are secured by an API Key. The Frontend may be configured to be accessed based on keycloak authentication. -Refer to the [Admin Guide](../adminGuide/Admin_Guide.md) for further information. +Refer to the [Admin Guide](../admin/Admin_Guide.md) for further information. Access to respective resources is always granted based on the actual relationships as stated in section 'Multi-Partner Information'. Means there are two levels of security: @@ -232,7 +232,7 @@ To do the second, the Connector in use needs the extension [provision additional headers](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/provision-additional-headers). Beside that the Backend can be configured to use the DTR with an IDP. The PURIS application could differentiate two -users. For configuration, please refer to the [Admin Guide](../adminGuide/Admin_Guide.md). +users. For configuration, please refer to the [Admin Guide](../admin/Admin_Guide.md). - read access client for the EDC: added to the `dataAddress` of the DTR Asset - manage access client for the PURIS application: used to create and manage the ShellDescriptors diff --git a/docs/arc42/09_architecture_decisions.md b/docs/architecture/09_architecture_decisions.md similarity index 100% rename from docs/arc42/09_architecture_decisions.md rename to docs/architecture/09_architecture_decisions.md diff --git a/docs/arc42/10_quality_requirements.md b/docs/architecture/10_quality_requirements.md similarity index 100% rename from docs/arc42/10_quality_requirements.md rename to docs/architecture/10_quality_requirements.md diff --git a/docs/arc42/11_technical_risks.md b/docs/architecture/11_technical_risks.md similarity index 100% rename from docs/arc42/11_technical_risks.md rename to docs/architecture/11_technical_risks.md diff --git a/docs/arc42/12_glossary.md b/docs/architecture/12_glossary.md similarity index 100% rename from docs/arc42/12_glossary.md rename to docs/architecture/12_glossary.md diff --git a/docs/arc42/Index.md b/docs/architecture/Index.md similarity index 100% rename from docs/arc42/Index.md rename to docs/architecture/Index.md diff --git a/docs/arc42/img/03-business-context.svg b/docs/architecture/img/03-business-context.svg similarity index 100% rename from docs/arc42/img/03-business-context.svg rename to docs/architecture/img/03-business-context.svg diff --git a/docs/arc42/img/03-technical-context.svg b/docs/architecture/img/03-technical-context.svg similarity index 100% rename from docs/arc42/img/03-technical-context.svg rename to docs/architecture/img/03-technical-context.svg diff --git a/docs/arc42/img/05-level-0.svg b/docs/architecture/img/05-level-0.svg similarity index 100% rename from docs/arc42/img/05-level-0.svg rename to docs/architecture/img/05-level-0.svg diff --git a/docs/arc42/img/05-level-1-backend.svg b/docs/architecture/img/05-level-1-backend.svg similarity index 100% rename from docs/arc42/img/05-level-1-backend.svg rename to docs/architecture/img/05-level-1-backend.svg diff --git a/docs/arc42/img/05-level-1-frontend.svg b/docs/architecture/img/05-level-1-frontend.svg similarity index 100% rename from docs/arc42/img/05-level-1-frontend.svg rename to docs/architecture/img/05-level-1-frontend.svg diff --git a/docs/arc42/img/06-api-flow-detailed.svg b/docs/architecture/img/06-api-flow-detailed.svg similarity index 100% rename from docs/arc42/img/06-api-flow-detailed.svg rename to docs/architecture/img/06-api-flow-detailed.svg diff --git a/docs/architecture/img/06-twin-creation.svg b/docs/architecture/img/06-twin-creation.svg new file mode 100644 index 00000000..fa4b2953 --- /dev/null +++ b/docs/architecture/img/06-twin-creation.svg @@ -0,0 +1,4 @@ + +PURIS backendMaterialControllerMaterialControllerMaterialPartnerRelationsControllerMaterialPartnerRelationsControllerMaterialServiceImplMaterialServiceImplMaterialPartnerRelationServiceImplMaterialPartnerRelationServiceImplEdcAdapterServiceEdcAdapterServiceDtrAdapterServiceDtrAdapterServiceCreate or Update Material or Product1Create or Update Material or Productalt[create material or product]2Generate or takeCatena-X ID(save on material)3OK4Create or Updae MPR for partnerand material / product5Create DtrRegistrationTask6Determine Partners whobuy material and supply productDtrRegistrationTaskalt[at least one Partner who buys (We're the supplier)]7Create ShellDescriptor with access rights for buyingpartners and all submodels8OK[at least one Partner who sells (We're the customer)]alt[MPR does not yet have the CX-ID]9Lookup DigitalTwin at Supplierto extract Catena-X ID10Lookup and Contract DTR11Determine ShellDescriptor andSubmodel "DSP" Endpoint forPartTypeInformation frompartner DTR12Query PartTypeInformation Submodelat partner13Extract Catena-X ID from Submodel14Catena-X ID15Set Partner Catena-X ID16Save MaterialPartnerRelationship17Create or Update ShellDescriptor with access rights for sellingpartners and all submodels18OK19OK diff --git a/docs/arc42/img/07-deployment-argo.png b/docs/architecture/img/07-deployment-argo.png similarity index 100% rename from docs/arc42/img/07-deployment-argo.png rename to docs/architecture/img/07-deployment-argo.png diff --git a/docs/arc42/img/07-deployment-argo.svg b/docs/architecture/img/07-deployment-argo.svg similarity index 100% rename from docs/arc42/img/07-deployment-argo.svg rename to docs/architecture/img/07-deployment-argo.svg diff --git a/docs/arc42/img/07-deployment.png b/docs/architecture/img/07-deployment.png similarity index 100% rename from docs/arc42/img/07-deployment.png rename to docs/architecture/img/07-deployment.png diff --git a/docs/arc42/img/07-deployment.svg b/docs/architecture/img/07-deployment.svg similarity index 100% rename from docs/arc42/img/07-deployment.svg rename to docs/architecture/img/07-deployment.svg diff --git a/docs/arc42/puml/03-business-context.puml b/docs/architecture/puml/03-business-context.puml similarity index 100% rename from docs/arc42/puml/03-business-context.puml rename to docs/architecture/puml/03-business-context.puml diff --git a/docs/arc42/puml/03-technical-context.puml b/docs/architecture/puml/03-technical-context.puml similarity index 100% rename from docs/arc42/puml/03-technical-context.puml rename to docs/architecture/puml/03-technical-context.puml diff --git a/docs/arc42/puml/05-level-0.puml b/docs/architecture/puml/05-level-0.puml similarity index 100% rename from docs/arc42/puml/05-level-0.puml rename to docs/architecture/puml/05-level-0.puml diff --git a/docs/arc42/puml/05-level-1-backend.puml b/docs/architecture/puml/05-level-1-backend.puml similarity index 100% rename from docs/arc42/puml/05-level-1-backend.puml rename to docs/architecture/puml/05-level-1-backend.puml diff --git a/docs/arc42/puml/05-level-1-frontend.puml b/docs/architecture/puml/05-level-1-frontend.puml similarity index 100% rename from docs/arc42/puml/05-level-1-frontend.puml rename to docs/architecture/puml/05-level-1-frontend.puml diff --git a/docs/arc42/puml/06-api-flow-detailed.puml b/docs/architecture/puml/06-api-flow-detailed.puml similarity index 100% rename from docs/arc42/puml/06-api-flow-detailed.puml rename to docs/architecture/puml/06-api-flow-detailed.puml diff --git a/docs/arc42/puml/06-twin-creation.puml b/docs/architecture/puml/06-twin-creation.puml similarity index 100% rename from docs/arc42/puml/06-twin-creation.puml rename to docs/architecture/puml/06-twin-creation.puml diff --git a/docs/arc42/puml/07-deployment-argo.puml b/docs/architecture/puml/07-deployment-argo.puml similarity index 100% rename from docs/arc42/puml/07-deployment-argo.puml rename to docs/architecture/puml/07-deployment-argo.puml diff --git a/docs/arc42/puml/07-deployment.puml b/docs/architecture/puml/07-deployment.puml similarity index 100% rename from docs/arc42/puml/07-deployment.puml rename to docs/architecture/puml/07-deployment.puml diff --git a/docs/userGuide/User_Guide.md b/docs/user/User_Guide.md similarity index 100% rename from docs/userGuide/User_Guide.md rename to docs/user/User_Guide.md diff --git a/docs/userGuide/img/catalog_view.png b/docs/user/img/catalog_view.png similarity index 100% rename from docs/userGuide/img/catalog_view.png rename to docs/user/img/catalog_view.png diff --git a/docs/userGuide/img/catalog_view_list.png b/docs/user/img/catalog_view_list.png similarity index 100% rename from docs/userGuide/img/catalog_view_list.png rename to docs/user/img/catalog_view_list.png diff --git a/docs/userGuide/img/dashboard_view.png b/docs/user/img/dashboard_view.png similarity index 100% rename from docs/userGuide/img/dashboard_view.png rename to docs/user/img/dashboard_view.png diff --git a/docs/userGuide/img/dashboard_view_list.png b/docs/user/img/dashboard_view_list.png similarity index 100% rename from docs/userGuide/img/dashboard_view_list.png rename to docs/user/img/dashboard_view_list.png diff --git a/docs/userGuide/img/negotiations_view.png b/docs/user/img/negotiations_view.png similarity index 100% rename from docs/userGuide/img/negotiations_view.png rename to docs/user/img/negotiations_view.png diff --git a/docs/userGuide/img/negotiations_view_list.png b/docs/user/img/negotiations_view_list.png similarity index 100% rename from docs/userGuide/img/negotiations_view_list.png rename to docs/user/img/negotiations_view_list.png diff --git a/docs/userGuide/img/stock_view.png b/docs/user/img/stock_view.png similarity index 100% rename from docs/userGuide/img/stock_view.png rename to docs/user/img/stock_view.png diff --git a/docs/userGuide/img/stock_view_added_material_stock.png b/docs/user/img/stock_view_added_material_stock.png similarity index 100% rename from docs/userGuide/img/stock_view_added_material_stock.png rename to docs/user/img/stock_view_added_material_stock.png diff --git a/docs/userGuide/img/stock_view_selected_material_stock.png b/docs/user/img/stock_view_selected_material_stock.png similarity index 100% rename from docs/userGuide/img/stock_view_selected_material_stock.png rename to docs/user/img/stock_view_selected_material_stock.png diff --git a/docs/userGuide/img/transfers_view.png b/docs/user/img/transfers_view.png similarity index 100% rename from docs/userGuide/img/transfers_view.png rename to docs/user/img/transfers_view.png diff --git a/docs/userGuide/img/transfers_view_list.png b/docs/user/img/transfers_view_list.png similarity index 100% rename from docs/userGuide/img/transfers_view_list.png rename to docs/user/img/transfers_view_list.png