R 24.05. Behaviour Twin KIT (v1.0.0) added, Remaining useful Life KIT and Health Indicator KIT removed #889

afederl · 2024-05-16T12:11:08Z

Description

Added

new KIT: Behaviour Twin KIT, version 1.0.0.
- Initial version of the (generalized) Behaviour Twin KIT.
- The design and outline are slightly different from what other KITs do.
- Sidebars, Gallery and configs are adapted.

Removed

Remaining useful Life KIT since it is deprecated, and its contents are integrated into the new Behaviour Twin KIT.
Health Indicator KIT since it is deprecated, and its contents are integrated into the new Behaviour Twin KIT.

…tion finished, Development View and Use Cases need some more work. Health Indicator KIT and Remaining useful Life KIT removed (integrated into Behaviour Twin KIT).

…ur Twin RuL KIT folder.

danielmiehle

Very good revision of the KIT. Good description, especially how to start new use cases and the required resources.

Please add the missing legal notice sections. The remaining comments are only minor notes.

danielmiehle · 2024-05-22T05:54:28Z

docs-kits/kits/behaviour-twin-kit/adoption-view/architecture.md

+
+### OVERVIEW
+
+A use case consists of data and calculation services. In addition, a logic is required, that defines how data and services must interact to produce the desired result. This logic is called "skill". It must be invoked directly or indirectly by the consumer.


I would suggest to add a link to definition of a "skill" in the Agent KIT

We will write a short definition of skills in the Adoption View/Knowledge Agent page. There, we will reference to the definition at the Agents KIT (href=docs-kits/next/kits/knowledge-agents/development-view/modelling#skill).

danielmiehle · 2024-05-22T05:59:32Z

docs-kits/kits/behaviour-twin-kit/adoption-view/architecture.md

@@ -0,0 +1,208 @@
+---
+id: architecture


Non-blocking: In general, I would prefer to have an own "sub-menu-item" for the architecture view (see e.g., Traceability KIT.

This would require a big change of our structure. We prefer to leave it as is. The contents build on each other, so we need less cross-references. This makes the KIT more easy to read.

danielmiehle · 2024-05-22T06:02:38Z

docs-kits/kits/behaviour-twin-kit/adoption-view/new-use-cases.md

@@ -0,0 +1,37 @@
+---


I like this section! However, does it make sense to move it rather to the development view?

We would prefer to leave it in the Adoption View. The content referes to general steps like joining Catena-X as well as development-specific steps.

danielmiehle · 2024-05-22T06:04:07Z

docs-kits/kits/behaviour-twin-kit/adoption-view/terminology.md

@@ -0,0 +1,78 @@
+---
+id: terminology


@jSchuetz88 : Input for the overarching glossary!
https://catenax-ev.github.io/docs/next/working-model/glossary

danielmiehle · 2024-05-22T06:08:16Z

docs-kits/kits/behaviour-twin-kit/changelog.md

+
+- ./.
+
+### CHANGED


If no content has been changed or deleted, I would leave out the bullet points.
What is the difference between KIT and Use Cases? Do we need this distinction?

Will be done. The destinction should be preserved because use cases may be developed independently of the general part of the KIT. This provides a better overview.

docs-kits/kits/behaviour-twin-kit/adoption-view/introduction.md

docs-kits/kits/behaviour-twin-kit/development-view/overview.md

danielmiehle · 2024-05-22T06:22:36Z

docs-kits/kits/behaviour-twin-kit/overview.md

@@ -0,0 +1,37 @@
+---


@AngelikaWittek: Can you please help if this PR needs an Eclipse IP check (e.g. over 1000 loc)?

Background: Two KITs were merged into one KIT. Therefore, nothing has changed in terms of content - only the structure has been restructured

There are some additional/revised code blocks (e.g. skills). These are provided by the Agents KIT (the new/next Agents KIT version 24-05 will contain all the examples). We added the contributors at the legal notice(s) and they are mentioned in the headers of the code blocks.

danielmiehle · 2024-05-22T06:24:07Z

docs-kits/kits/behaviour-twin-kit/adoption-view/guidance-and-resources.md

@@ -0,0 +1,37 @@
+---


Does it make sense to also move it rather to the development view?

Will be done.

…nt View as well as to the overview pages of the use cases section. Moved guidance page to Development View. Described skills and shapes graphs in more detail. Added diagrams for better description of role combinations. Added extended description with diagrams to the benefits in the Adoption View. Some minor corrections.

…duction to Knowledge Agent section.

HFocken

Thank you! Great addition and simplified user guidance through the one KIT structure - minor change requests, then good to go!

HFocken · 2024-05-23T15:32:08Z

docs-kits/kits/behaviour-twin-kit/adoption-view/to-be-considered.md

+
+![supply chain visibility](assets/supply-chain-visibility.drawio.svg)
+
+To engage additional actors in the supply chain, the framework agreements and other requirements must be propagated through the chain.


Very broad statement - especially on one up one down - I would prefer that per definition we keep one up one down. Individual agreements are possible, but per design, Catena-X does not foresee breaking out of this guideline.

I know that for BT we had not managed to finalize the predefined use case framework yet, but you could still link here for the general page where those are listed:
https://catena-x.net/en/catena-x-introduce-implement/governance-framework-for-data-space-operations

Revised the description.

HFocken · 2024-05-23T15:34:42Z

docs-kits/kits/behaviour-twin-kit/adoption-view/versioning.md

+  </div>
+</div>
+
+## CATENA-X RELEASES


I would remove this section completely as it is not KIT-specific- Catena-X Release Management is handled in the CX Association - I would broadly defer to the CX Website.

If you do want to keep it in, please rename "main" into "major".

Revised the description and moved it into the To Be Considered page.

HFocken · 2024-05-23T15:36:01Z

docs-kits/kits/behaviour-twin-kit/assets/caution.drawio.svg

I'm not getting a picture displayed here - intentional or technical error?

Replaced the svg file and used instead the ⚠️ emoji.

HFocken · 2024-05-23T15:36:06Z

docs-kits/kits/behaviour-twin-kit/assets/external-link.svg

I'm not getting a picture displayed here - intentional or technical error?

For the external link symbol, I couldn't find a replacement. Do you know, how to replace it?
The svg is displayed in my local generated docusaurus pages, in GitHub (different browsers) and in preview mode of VSCode.

docs-kits/kits/behaviour-twin-kit/use-cases/hi/development-view/service-bindings.md

docs-kits/kits/behaviour-twin-kit/use-cases/overview.md

docs-kits/kits/behaviour-twin-kit/use-cases/rul/development-view/service-bindings.md

docs-kits/kits/behaviour-twin-kit/use-cases/rul/development-view/skill.md

jSchuetz88

Looks good to me too. In addition to the other comments, only minor remarks from my side.

afederl · 2024-05-24T11:23:58Z

docs-kits/kits/behaviour-twin-kit/use-cases/rul/overview.md

+description: Behaviour Twin KIT
+---
+
+<div style={{fontSize:30, color:'rgb(255,166,1)', marginBottom:13}}>Behaviour Twin KIT -- Remaining useful Life</div>


Now, I set hide_title: true.

HTML is used to provide color for that special headline. # would not work because it would be a multiple top level headline. By setting hide_title: true, I got rid of the redundant headline now.

docs-kits/kits/behaviour-twin-kit/use-cases/rul/overview.md

docs-kits/kits/behaviour-twin-kit/use-cases/rul/development-view/skill.md

jSchuetz88 · 2024-05-24T00:18:37Z

docs-kits/kits/behaviour-twin-kit/use-cases/rul/adoption-view/architecture.md

+
+![business-process](assets/business-process.drawio.svg)
+
+0. **sync federated catalog:** <br/> The federated catalogs are synchronized periodically. As a result, the OEM can resolve RuL prognosis function assets that are located at the supplier.


Minor remark: Markdown notation / linebreaks should be preferred to an HTML-tag

The desired result (line break within a list element) is not possible without HTML as I know. If there is a better solution, please let me know.

docs-kits/kits/behaviour-twin-kit/use-cases/hi/overview.md

docs-kits/kits/behaviour-twin-kit/use-cases/hi/adoption-view/overview.md

docs-kits/kits/behaviour-twin-kit/overview.md

docs-kits/kits/behaviour-twin-kit/development-view/overview.md

docs-kits/kits/behaviour-twin-kit/development-view/guidance-and-resources.md

docs-kits/kits/behaviour-twin-kit/adoption-view/overview.md

…moved contents into to-be-considered section. Updated all copyright dates to 2024.

afederl added 3 commits May 16, 2024 12:55

Initial version of the (generalized) Behaviour Twin KIT. general Adop…

d73cdcf

…tion finished, Development View and Use Cases need some more work. Health Indicator KIT and Remaining useful Life KIT removed (integrated into Behaviour Twin KIT).

Corrected error from last commit in KITs gallery.

c5c95ed

Behaviour Twin KIT: Resolved markdown issues.

c55e4ef

afederl requested a review from maximilianong May 16, 2024 12:19

afederl and others added 2 commits May 19, 2024 23:03

Merge branch 'eclipse-tractusx:main' into bt-kit-release

3801f81

Completed and revised generalized Behaviour Twin KIT. Removed Behavio…

76e7d3b

…ur Twin RuL KIT folder.

afederl changed the title ~~R 24.05. Behaviour Twin KIT (v0.1.0) added, Remaining useful Life KIT and Health Indicator KIT removed~~ R 24.05. Behaviour Twin KIT (v1.0.0) added, Remaining useful Life KIT and Health Indicator KIT removed May 19, 2024

afederl marked this pull request as ready for review May 19, 2024 21:25

afederl requested review from danielmiehle, HFocken and jSchuetz88 May 19, 2024 21:26

danielmiehle requested changes May 22, 2024

View reviewed changes

afederl added 2 commits May 23, 2024 02:08

Behaviour Twin KIT: Fixed markdown linting issues.

1b6edfa

afederl requested a review from danielmiehle May 23, 2024 00:15

Behaviour Twin KIT: Moved paragraph from detailed benefits from intro…

560247e

…duction to Knowledge Agent section.

HFocken suggested changes May 23, 2024

View reviewed changes

jSchuetz88 suggested changes May 24, 2024

View reviewed changes

Behaviour Twin KIT: Revised section VERSIONING/CATENA-X RELEASES and …

2a8d817

…moved contents into to-be-considered section. Updated all copyright dates to 2024.

afederl requested review from HFocken and jSchuetz88 May 24, 2024 11:26

afederl and others added 3 commits May 24, 2024 18:12

Minor corrections (typos, grammar, ...). No changes to content.

ab07937

Fixed markdown linter warning.

b7727d1

chore(DEPENDENCIES)

b5228e7

danielmiehle approved these changes May 27, 2024

View reviewed changes

jSchuetz88 approved these changes May 27, 2024

View reviewed changes

maximilianong approved these changes May 27, 2024

View reviewed changes

maximilianong merged commit 8803f36 into eclipse-tractusx:main May 27, 2024
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

R 24.05. Behaviour Twin KIT (v1.0.0) added, Remaining useful Life KIT and Health Indicator KIT removed #889

R 24.05. Behaviour Twin KIT (v1.0.0) added, Remaining useful Life KIT and Health Indicator KIT removed #889

afederl commented May 16, 2024 •

edited

danielmiehle left a comment

danielmiehle May 22, 2024

afederl May 22, 2024

danielmiehle May 22, 2024

afederl May 22, 2024

danielmiehle May 22, 2024

afederl May 22, 2024

danielmiehle May 22, 2024

danielmiehle May 22, 2024

afederl May 22, 2024

afederl May 23, 2024

danielmiehle May 22, 2024

afederl May 22, 2024

danielmiehle May 22, 2024

afederl May 22, 2024

afederl May 23, 2024

HFocken left a comment

HFocken May 23, 2024

afederl May 24, 2024

HFocken May 23, 2024

afederl May 24, 2024

HFocken May 23, 2024

afederl May 24, 2024

HFocken May 23, 2024

afederl May 24, 2024

jSchuetz88 left a comment

This comment was marked as resolved.

afederl May 24, 2024

jSchuetz88 May 24, 2024

afederl May 24, 2024


		### OVERVIEW

		A use case consists of data and calculation services. In addition, a logic is required, that defines how data and services must interact to produce the desired result. This logic is called "skill". It must be invoked directly or indirectly by the consumer.


		![supply chain visibility](assets/supply-chain-visibility.drawio.svg)

		To engage additional actors in the supply chain, the framework agreements and other requirements must be propagated through the chain.


		![business-process](assets/business-process.drawio.svg)

		0. sync federated catalog: <br/> The federated catalogs are synchronized periodically. As a result, the OEM can resolve RuL prognosis function assets that are located at the supplier.

R 24.05. Behaviour Twin KIT (v1.0.0) added, Remaining useful Life KIT and Health Indicator KIT removed #889

R 24.05. Behaviour Twin KIT (v1.0.0) added, Remaining useful Life KIT and Health Indicator KIT removed #889

Conversation

afederl commented May 16, 2024 • edited

Description

Added

Removed

danielmiehle left a 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

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

HFocken left a 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

jSchuetz88 left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afederl commented May 16, 2024 •

edited