Merge pull request #836 from nhaenis/dcm-kit-2405-content

doc(DCM): DCM KIT Content Release 24.05

docs-kits/kits/DCM-Kit/page_adoption-view.md

@@ -42,9 +42,9 @@ Implementing the DCM standards will add the following core capabilities to busin
 
 The DCM standard consists of three main elements:
 
-- **Core Business logic** – to focus on a **common understanding** of the **DCM processes** among the participants. **Version 1.0.0** (Release 24.03) [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library)
-- **Data model** – to align the structure of the shared data and enable the adoption of the core business logic without misinterpretation. **Version 1.0.0** (Release 24.03) [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library)
-- **APIs** – to make sure that data are transmitted and consumed properly as well as are identically interpreted across companies. **Version 1.0.0** (Release 24.03) [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library)
+- **Core Business logic** – to focus on a **common understanding** of the **DCM processes** among the participants. **Version 2.0.0** (Release 24.05) [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library)
+- **Data model** – to align the structure of the shared data and enable the adoption of the core business logic without misinterpretation. **Version 2.0.0** (Release 24.05) [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library)
+- **APIs** – to make sure that data are transmitted and consumed properly as well as are identically interpreted across companies. **Version 2.0.0** (Release 24.05) [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library)
 
 ### POWER of STANDARD
 
@@ -72,9 +72,9 @@ Of course, by realizing efficiency through improved collaboration all involved p
 
 | Semantic Model | Link to GitHub Repository |
 | ------------- | ------------- |
-| WeekBasedCapacityGroup  | <https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.week_based_capacity_group/2.0.0/WeekBasedCapacityGroup.ttl> |
-| MaterialDemand | <https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.material_demand/1.0.0/MaterialDemand.ttl> |
-| IdBasedRequestForUpdate | <https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.id_based_request_for_update/2.0.0/IdBasedRequestForUpdate.ttl> |
+| WeekBasedCapacityGroup  | <https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl> |
+| WeekBasedMaterialDemand | <https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.week_based_material_demand/3.0.0/WeekBasedMaterialDemand.ttl> |
+| IdBasedRequestForUpdate | <https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.id_based_request_for_update/3.0.0/IdBasedRequestForUpdate.ttl> |
 | IdBasedComment | <https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.id_based_comment/1.0.0/IdBasedComment.ttl> |
 
 ## Notice

docs-kits/kits/DCM-Kit/page_dcm-architecture-view.md → docs-kits/kits/DCM-Kit/page_architecture-view.md

@@ -14,13 +14,13 @@ This page is relevant for you, if one of the following cases applies:
 1. You want to participate in the demand and capacity usecase as either a customer or a supplier and intend to adapt your existing custom application landscape to Catena-X DCM.
 2. You want to offer business solutions to the aforementioned customers and suppliers by adapting your commercial software product for Catena-X DCM.
 
-If non of this applies to you or you are unsure, please refer to DCM guideline for solution adoption first.
+If none of this applies to you or you are unsure, please refer to [Operation View](page_operation-view.md) first.
 
-Note: if you purchase commercial software from a software vendor, the vendor needs to adopt their software for you. Please refer your vendor to this page.
+> Note: If you purchase commercial software from a software vendor, the vendor needs to adopt their software for you. Please refer your vendor to this page.
 
 ## Prerequisites
 
-In order to participate in the Catena-X network an Eclipse Dataspace Connector (EDC) is required, as the endpoints must not be called directly but only through an EDC.
+In order to participate in the Catena-X network an Eclipse Dataspace Connector (EDC), or a similar connector fulfilling the Dataspace Protocol, is required, as the endpoints must not be called directly but only through a Data Asset/Contract Offer.
 
 In addition use case participants need to be boarded onto the Catena-X network.
 
@@ -35,25 +35,25 @@ If you want to adapt your custom or commercial applications to work with the Cat
 1. Modify the source code of your application
 2. Enable your software to offer multiple REST API endpoints in order to receive data
 3. Enable your software to call multiple REST API endpoints in order to send data
-4. Enable your software the communicate through an  Eclipse Dataspace Connector (EDC), which is to be setup separately
+4. Enable your software to communicate through an Eclipse Dataspace Connector (EDC), or a similar solution, which is to be setup separately
 
-For details, please refer to the Catena-X standard [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library). This page provides a non-normative overview only.
+For details, please refer to the Catena-X DCM standard [CX-0128](https://catena-x.net/de/standard-library). This page provides a non-normative overview only.
 
 ## Solution Overview
 
 For the exchange of the demand and capacity information required by the process, five REST APIs are used:
 
-- MaterialDemand API - used for the exchange of demand information
+- WeekBasedMaterialDemand API - used for the exchange of demand information
 - WeekBasedCapacityGroup API - used for the exchange of capacity information
-- RequestForUpdate API - used for requesting an update of MaterialDemand or WeekBasedCapacityGroup
-- IdBasedComment API - used for the exchange of additional comments regarding MaterialDemand or WeekBasedCapacityGroup
+- RequestForUpdate API - used for requesting an update of WeekBasedMaterialDemand or WeekBasedCapacityGroup
+- IdBasedComment API - used for the exchange of additional comments regarding WeekBasedMaterialDemand or WeekBasedCapacityGroup
 - Asset Administration Shell (AAS) API - used when using DCM in combination with a Digital Twin Registry
 
 All those APIs are REST-based APIs.
 
 Implementing all endpoints is mandatory, except the AAS API endpoint, which is optional.
 
-Note that the software solutions used as well as the business process should be enabled in order to receive MaterialDemand information from customers and send WeekBasedCapacityGroup information back to those customers. Also, it needs to be possible to send the own MaterialDemand information to the suppliers and receive their WeekBasedCapacityGroup information in return. Therefore, the software tools used need to be able to send/receive these information and the users need to be able to work with the information in the planning processes.
+Note that the software solutions used as well as the business process should be enabled in order to receive WeekBasedMaterialDemand information from customers and send WeekBasedCapacityGroup information back to those customers. Also, it needs to be possible to send the own WeekBasedMaterialDemand information to the suppliers and receive their WeekBasedCapacityGroup information in return. Therefore, the software tools used need to be able to send/receive these information and the users need to be able to work with the information in the planning processes.
 
 When implementing the API endpoints, it is important to follow the DCM standard closely in order to ensure compatibility with other solutions. This is not limited to technical aspects, but also extends to the business definition of demand and capacity.
 
@@ -62,7 +62,7 @@ When implementing the API endpoints, it is important to follow the DCM standard
 | Constraint ID | Constraint |
 | ------------- | ------------- |
 | C-1 | Software and third party software must be compliant to the Catena-X and Eclipse Foundation Guidelines/Policies [eclipse_foundation](https://www.eclipse.org/projects/dev_process/) |
-| C-2 | [Eclipse Dataspace Connector](https://github.com/eclipse-tractusx/tractusx-edc/tree/main) (EDC) must be used for data transfer between different legal entities; e.g. the API endpoints listed above may only be called through an EDC |
+| C-2 | [Eclipse Dataspace Connector](https://github.com/eclipse-tractusx/tractusx-edc/tree/main) (EDC), or a similar solution, must be used for data transfer between different legal entities; e.g. the API endpoints listed above may only be called through a Data Asset/Contract Offer |
 
 ## Sequence Diagram
 

docs-kits/kits/DCM-Kit/page_changelog.md

@@ -17,11 +17,15 @@ All notable changes to this Kit will be documented in this file.
 
 ### Added
 
-- ./.
+- Added [DCM Operation View](page_operation-view.md)
 
 ### Changed
 
 - Changed banner image file location and converted .png image to .svg
+- Updated aspect models in [Adoption View](page_adoption-view.md) to new versions
+- Updated aspect models and API definitions in [Development View](page_development-view.md) to new versions
+- Updated WeekBasedMaterialDemand data model and API chapters to new data model (Replaced MaterialDemand with WeekBasedMaterialDemand aspect model)
+- Updated choice of words and writing pattern throughout the documentation
 
 ### Removed