docs: DCM-Kit Content Release 24.03 #677

nhaenis · 2024-02-15T15:22:54Z

Description

What does this PR introduce? DCM-Kit Content for Releas 24.03
Does it fix a bug? Nope
Does it add a new feature? documentation only
Is it enhancing documentation? Yes, but for a new release

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

DEPENDENCIES are up-to-date. Dash license tool. Committers can open IP issues for restricted libs.
Copyright and license header are present on all affected files

…e-tractusx.github.io into dcm-content-r2403

… and Capacity Management Data Exchange]

SebastianBezold

There has been a decision and also communication, that we will publish openAPI specs on SwaggerHub and no longer have that on the website.

So please remove all openAPI related config + yaml files.
this will also maybe reduce the PR content to a level, that we do not have to create a project contribution check with the EF

nhaenis · 2024-02-22T13:56:06Z

There has been a decision and also communication, that we will publish openAPI specs on SwaggerHub and no longer have that on the website.

So please remove all openAPI related config + yaml files. this will also maybe reduce the PR content to a level, that we do not have to create a project contribution check with the EF

removed

nhaenis · 2024-02-23T10:05:36Z

@ reviewers: PR w/a finalized version of DCM guideline for solution adoption which is referenced in DCM arc42 - will be integraded asap, the rest of the content has been in our use case since last week without feedback, which should remain stable

maximilianong · 2024-02-27T14:26:37Z

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

+- Documentation Adoption View based on Catena-X release
+- Documentation Development View based on Catena-X release


We do not really understand what "based on Catena-X release" means - would be nice if you could become a bit more concrete here.

Described in more detail

maximilianong · 2024-02-27T14:26:47Z

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

@@ -11,6 +11,22 @@ sidebar_position: 1

 All notable changes to this Kit will be documented in this file.

+## [0.2.0] - 2024-02-xx


Please add the date of the release: 2024-03-08

maximilianong · 2024-02-27T14:30:28Z

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

- **APIs** – to make sure that data are transmitted and consumed properly as well as are identically interpreted across companies. **Version 1.0.0** (Release 3.1) [CX-0048 DCM API Material Demand & Capacity Group](https://catena-x.net/de/standard-library)
+- **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)

 ### POWER of STANDARD


Are those statements really necessary as H3? Because they are showing up in the right navigation and we want to keep this as lean as possible.

Changed to ** bold ** -> Linter error message can be ignored

maximilianong · 2024-02-27T14:31:29Z

docs-kits/kits/DCM-Kit/page_dcm-architecture-documentation-arc42.md

This is not really an ARC42. This is more like high-level architecture. Can we change the title of this page to 'Architecture View'

maximilianong · 2024-02-27T14:32:21Z

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

+
+This document describes the `MaterialDemand`, `WeekBasedCapacityGroup`, `IdBasedRequestForUpdate` and `IdBasedComment` semantic models and the API definitions used in the DCM Catena-X network.
+
+## ASPECT MODELS


Please do not use so much capital letters :)

danielmiehle · 2024-02-27T14:32:50Z

@nhaenis can you please fix the linting issues for the DCM KIT.

maximilianong

Ready to go for R 24.03, thanks @nhaenis

nhaenis · 2024-03-06T08:08:52Z

@danielmiehle / @maximilianong resolved conflict - should be able to merge now

maximilianong · 2024-03-06T13:49:06Z

There has been a decision and also communication, that we will publish openAPI specs on SwaggerHub and no longer have that on the website.

So please remove all openAPI related config + yaml files. this will also maybe reduce the PR content to a level, that we do not have to create a project contribution check with the EF

Please approve this - merging is blocked at the moment and we need to release this

SebastianBezold · 2024-03-07T08:38:22Z

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

- SPDX-FileCopyrightText: 2023,2023 Henkel AG & Co.KGaA
- SPDX-FileCopyrightText: 2023,2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer)
- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse
+- SPDX-FileCopyrightText: 2023-2024 ZF Friedrichshafen AG


Copyright ranges are marked with , instead of -.

see Eclipse Foundation Project Handbook

SebastianBezold

Fine with me, but the copyright year range should be fixed. Would be fine for me if this is done in a separate PR

See comment: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/pull/677/files#r1515753997

…e-tractusx.github.io into dcm-content-r2403

maximilianong

Thanks @nhaenis for adapting the changes.

nhaenis added 11 commits February 13, 2024 15:50

Rearrange DCM Kit structure, remove blanks from folder names

41846d2

Add DCM API definitions into Kit structure

99d4bd8

Merge branch 'main' into dcm-content-r2403

2f01c07

Merge branch 'eclipse-tractusx:main' into dcm-content-r2403

bca8b9e

Merge branch 'main' into dcm-content-r2403

a56837f

Merge branch 'dcm-content-r2403' of https://github.com/nhaenis/eclips…

e63ab35

…e-tractusx.github.io into dcm-content-r2403

Add DCM 24.03 Content

b0eeb85

Punkt ergänzt

01c5b07

Merge branch 'main' into dcm-content-r2403

142921a

Replace [CX-0128 Demand and Capacity Management] with [CX-0128 Demand…

f67740a

… and Capacity Management Data Exchange]

Merge branch 'main' into dcm-content-r2403

d300c95

nhaenis mentioned this pull request Feb 19, 2024

[DCM-Kit] Release Checks eclipse-tractusx/sig-release#538

Closed

18 tasks

SebastianBezold suggested changes Feb 22, 2024

View reviewed changes

Removed DCM API definitions

e1f6745

Merge branch 'main' into dcm-content-r2403

a447f16

danielmiehle requested review from danielmiehle and maximilianong February 23, 2024 09:51

nhaenis requested a review from SebastianBezold February 26, 2024 07:38

maximilianong requested changes Feb 27, 2024

View reviewed changes

nhaenis added 7 commits February 27, 2024 16:15

Review comments cleanup

2b6142b

Incorporated feedback for release

24d38ef

Update changelog

116e4b7

Fix headings for TOC

5683dc8

Merge branch 'main' into dcm-content-r2403

09c3429

Merge branch 'main' into dcm-content-r2403

7ea6dc0

Fix static URL refs DCM to kebap-case URLs

7968941

maximilianong previously approved these changes Feb 29, 2024

View reviewed changes

danielmiehle previously approved these changes Mar 6, 2024

View reviewed changes

Merge branch 'main' into dcm-content-r2403

14a828e

nhaenis dismissed stale reviews from danielmiehle and maximilianong via 14a828e March 6, 2024 07:53

maximilianong requested review from danielmiehle and maximilianong March 6, 2024 13:46

maximilianong previously approved these changes Mar 6, 2024

View reviewed changes

danielmiehle previously approved these changes Mar 6, 2024

View reviewed changes

SebastianBezold reviewed Mar 7, 2024

View reviewed changes

SebastianBezold previously approved these changes Mar 7, 2024

View reviewed changes

nhaenis added 2 commits March 7, 2024 09:44

Copyright ranges marked with , instead of -

66f84dd

Merge branch 'dcm-content-r2403' of https://github.com/nhaenis/eclips…

742c3ae

…e-tractusx.github.io into dcm-content-r2403

nhaenis dismissed stale reviews from SebastianBezold, danielmiehle, and maximilianong via 742c3ae March 7, 2024 08:45

maximilianong requested review from SebastianBezold and maximilianong March 7, 2024 08:59

maximilianong approved these changes Mar 7, 2024

View reviewed changes

SebastianBezold approved these changes Mar 7, 2024

View reviewed changes

maximilianong merged commit 2d24d22 into eclipse-tractusx:main Mar 7, 2024
4 of 5 checks passed

nhaenis deleted the dcm-content-r2403 branch March 7, 2024 09:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: DCM-Kit Content Release 24.03 #677

docs: DCM-Kit Content Release 24.03 #677

nhaenis commented Feb 15, 2024

SebastianBezold left a comment

nhaenis commented Feb 22, 2024

nhaenis commented Feb 23, 2024

maximilianong Feb 27, 2024

nhaenis Feb 28, 2024

maximilianong Feb 27, 2024

nhaenis Feb 28, 2024

maximilianong Feb 27, 2024

nhaenis Feb 28, 2024

maximilianong Feb 27, 2024

nhaenis Feb 28, 2024

maximilianong Feb 27, 2024

nhaenis Feb 28, 2024

danielmiehle commented Feb 27, 2024

maximilianong left a comment

nhaenis commented Mar 6, 2024

maximilianong commented Mar 6, 2024

SebastianBezold Mar 7, 2024

SebastianBezold left a comment

maximilianong left a comment

		- Documentation Adoption View based on Catena-X release
		- Documentation Development View based on Catena-X release

		@@ -11,6 +11,22 @@ sidebar_position: 1

		All notable changes to this Kit will be documented in this file.

		## [0.2.0] - 2024-02-xx


		This document describes the `MaterialDemand`, `WeekBasedCapacityGroup`, `IdBasedRequestForUpdate` and `IdBasedComment` semantic models and the API definitions used in the DCM Catena-X network.

		## ASPECT MODELS

docs: DCM-Kit Content Release 24.03 #677

docs: DCM-Kit Content Release 24.03 #677

Conversation

nhaenis commented Feb 15, 2024

Description

Pre-review checks

SebastianBezold left a comment

Choose a reason for hiding this comment

nhaenis commented Feb 22, 2024

nhaenis commented Feb 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danielmiehle commented Feb 27, 2024

maximilianong left a comment

Choose a reason for hiding this comment

nhaenis commented Mar 6, 2024

maximilianong commented Mar 6, 2024

Choose a reason for hiding this comment

SebastianBezold left a comment

Choose a reason for hiding this comment

maximilianong left a comment

Choose a reason for hiding this comment