From 342a348a3858ddb235bbe002e98efae63220e821 Mon Sep 17 00:00:00 2001 From: Malte Hellmeier Date: Thu, 15 Feb 2024 13:26:47 +0100 Subject: [PATCH 01/10] feat: enable markdown linter for kits --- .github/workflows/lint-on-pull-request.yaml | 5 ++++- README.md | 4 ++-- package.json | 1 + 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/workflows/lint-on-pull-request.yaml b/.github/workflows/lint-on-pull-request.yaml index f99e535daac..223ed0f2651 100644 --- a/.github/workflows/lint-on-pull-request.yaml +++ b/.github/workflows/lint-on-pull-request.yaml @@ -41,5 +41,8 @@ jobs: - name: Install dependencies run: npm ci - - name: Run markdown lint + - name: Run markdown lint for docs folder run: npm run lint-doc + + - name: Run markdown lint for docs-kits folder + run: npm run lint-kits diff --git a/README.md b/README.md index ba04f0037b7..b08718e3504 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,6 @@ We do want to follow a specific style for our markdown based documentation. Therefore, this repository is configured to use a [markdown linter](https://github.com/DavidAnson/markdownlint-cli2). Specific rules are configured via [.markdownlint.yaml](./.markdownlint.yaml). -Additionally, there is a npm script `lint-doc`, that will lint all the markdown files inside [docs](./docs). +Additionally, there is a npm script `lint-doc`, that will lint all the markdown files inside [docs](./docs) and `lint-kits`, that will lint all the markdown files inside [docs-kits](./docs-kits). This script is also run as a pre-commit hook, set up via [husky](https://www.npmjs.com/package/husky). -You can also run the linting step manually by running `npm run lint-doc`. +You can also run the linting step manually by running `npm run lint-doc` or `npm run lint-kits`. diff --git a/package.json b/package.json index d3579f7f826..1397a5213ca 100644 --- a/package.json +++ b/package.json @@ -13,6 +13,7 @@ "write-translations": "docusaurus write-translations", "write-heading-ids": "docusaurus write-heading-ids", "lint-doc": "markdownlint-cli2-config .markdownlint.yaml \"docs/**/*.md\" \"#node_modules\"", + "lint-kits": "markdownlint-cli2-config .markdownlint.yaml \"docs-kits/**/*.md\" \"#node_modules\"", "prepare": "husky install" }, "dependencies": { From cf5485545f7e56860f18f54b35941a9df79acf91 Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Thu, 15 Feb 2024 16:00:19 +0100 Subject: [PATCH 02/10] docs(community): add SIG introduction --- community/sigs/01_intro.md | 10 ++++++++++ community/sigs/02_sig_infra.md | 20 ++++++++++++++++++++ community/sigs/03_sig_security.md | 7 +++++++ community/sigs/04_sig_release.md | 9 +++++++++ sidebarsCommunity.js | 11 +++++++++++ 5 files changed, 57 insertions(+) create mode 100644 community/sigs/01_intro.md create mode 100644 community/sigs/02_sig_infra.md create mode 100644 community/sigs/03_sig_security.md create mode 100644 community/sigs/04_sig_release.md diff --git a/community/sigs/01_intro.md b/community/sigs/01_intro.md new file mode 100644 index 00000000000..0cb280327e1 --- /dev/null +++ b/community/sigs/01_intro.md @@ -0,0 +1,10 @@ +--- +title: "What is a SIG?" +--- + +Eclipse Tractus-X consists of different applications, products, KITs and also hosts other supporting repositories. +All of these repositories have a very dedicated goal and focus. +However, there are of course cross-cutting concerns, that affect our whole project. + +To foster these cross-cutting needs, we decided to form "Special Interest Groups", or "SIGs" in short. +SIGs diff --git a/community/sigs/02_sig_infra.md b/community/sigs/02_sig_infra.md new file mode 100644 index 00000000000..d7b61f9aaba --- /dev/null +++ b/community/sigs/02_sig_infra.md @@ -0,0 +1,20 @@ +--- +title: "SIG Infra" +--- + +__Focus:__ Creating automation for various Eclipse Tractus-X topics like CI or release. + +__Repository:__ [eclipse-tractusx/sig-infra](https://github.com/eclipse-tractusx/sig-infra) + +## Intro + +SIG infra is striving to improve the developer experience in Eclipse Tractus-X, by working on different automation topics. +We are also providing guidance on how to work with [Helm](https://helm.sh/) and support the [e2e-testing](https://github.com/eclipse-tractusx/e2e-testing) +approach, that will be based on a umbrella Chart and Helm tests. + +## Dash automation + +A topic, every Tractus-X repo has to take care of, is legal compliance. +One of the aspects is an up-to-date `DEPENDENCIES` file, generated by [eclipse dash-license](https://github.com/eclipse/dash-licenses). +SIG infra is maintaining a [run-dash](https://github.com/eclipse-tractusx/sig-infra/tree/main/.github/actions/run-dash) +GitHub action, that helps to ensure the `DEPENDENCIES` file stays up-to-date. diff --git a/community/sigs/03_sig_security.md b/community/sigs/03_sig_security.md new file mode 100644 index 00000000000..6c6197a635b --- /dev/null +++ b/community/sigs/03_sig_security.md @@ -0,0 +1,7 @@ +--- +title: "SIG Security" +--- + +__Focus:__ Define and maintain security best practices for Eclipse Tractus-X. Provide guidance on security related topics and incidents + +__Repository:__ [eclipse-tractusx/sig-security](https://github.com/eclipse-tractusx/sig-security) diff --git a/community/sigs/04_sig_release.md b/community/sigs/04_sig_release.md new file mode 100644 index 00000000000..153277a89e6 --- /dev/null +++ b/community/sigs/04_sig_release.md @@ -0,0 +1,9 @@ +--- +title: "SIG Release" +--- + +__Focus:__ Planning Tractus-X releases and product roadmaps. Defining the release process + +__Repository:__ [eclipse-tractusx/sig-release](https://github.com/eclipse-tractusx/sig-release) + +__Project:__ [Release Planning](https://github.com/orgs/eclipse-tractusx/projects/26) diff --git a/sidebarsCommunity.js b/sidebarsCommunity.js index cd56a42c1f9..ee06abc5b6d 100644 --- a/sidebarsCommunity.js +++ b/sidebarsCommunity.js @@ -21,6 +21,17 @@ const sidebars = { community: [ 'intro', 'open-meetings', + { + type: 'category', + label: 'Special Interest Groups (SIGs)', + collapsed: true, + items: [ + { + type: 'autogenerated', + dirName: 'sigs', + }, + ], + }, 'products', { type: 'link', From e8bc04376201308f6cbec5f0725b6ca335c6b955 Mon Sep 17 00:00:00 2001 From: Unsharm Date: Fri, 16 Feb 2024 12:53:26 +0530 Subject: [PATCH 03/10] Docs(business-partner-kit):use case url updated and notice updated --- .../page_adoption-view.mdx | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs-kits/kits/Business Partner Kit/page_adoption-view.mdx b/docs-kits/kits/Business Partner Kit/page_adoption-view.mdx index 06b981bf026..9240ffe08e3 100644 --- a/docs-kits/kits/Business Partner Kit/page_adoption-view.mdx +++ b/docs-kits/kits/Business Partner Kit/page_adoption-view.mdx @@ -48,7 +48,7 @@ as a shared and cost-optimized service (quality tested by the biggest players). Most of today’s automotive companies have to invest a significant amount of resources to keep their individual partner master data updated and correct, since outdated or incorrect data records result in federal fines and wrong claims / billing processes. The industry spends a vast amount into an area that is non differentiating, regulated and executed redundantly across the partners. For this, cutting individual company costs by offering the golden master data record as a shared service is the mission. And proactively reduce Business Partner risk via collaborative value-add services. -More insights to the business partner data management use case here: [Catena-X | Business Partner Use Case](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/5_PC_BPDM_v.2.1/BPM_-_001_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v2.1.pdf) +More insights to the business partner data management use case here: [Catena-X | Business Partner Use Case](https://catena-x.net/en/offers-standards/bpdm) This will become the industry’s largest golden record collection as a shared and cost-optimized service (quality tested by the biggest players). @@ -80,13 +80,13 @@ Our relevant standards can be downloaded from the official [Catena-X Standard Li This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 Volkswagen AG -- SPDX-FileCopyrightText: 2023,2023 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023,2023 Mercedes Benz Group -- SPDX-FileCopyrightText: 2023,2023 BASF SE -- SPDX-FileCopyrightText: 2023,2023 Schaeffler AG -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation +- SPDX-FileCopyrightText: 2023,2024 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023,2024 SAP SE +- SPDX-FileCopyrightText: 2023,2024 Volkswagen AG +- SPDX-FileCopyrightText: 2023,2024 Robert Bosch GmbH +- SPDX-FileCopyrightText: 2023,2024 Mercedes Benz Group +- SPDX-FileCopyrightText: 2023,2024 BASF SE +- SPDX-FileCopyrightText: 2023,2024 Schaeffler AG +- SPDX-FileCopyrightText: 2023,2024 Contributors to the Eclipse Foundation - Source URL: https://github.com/eclipse-tractusx/bpdm From 67ba0ea6255e3b2839f3461104dc98de9bb643e9 Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Fri, 16 Feb 2024 09:08:43 +0100 Subject: [PATCH 04/10] docs(community): address review comments --- community/sigs/01_intro.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/community/sigs/01_intro.md b/community/sigs/01_intro.md index 0cb280327e1..52a1c7603df 100644 --- a/community/sigs/01_intro.md +++ b/community/sigs/01_intro.md @@ -4,7 +4,7 @@ title: "What is a SIG?" Eclipse Tractus-X consists of different applications, products, KITs and also hosts other supporting repositories. All of these repositories have a very dedicated goal and focus. -However, there are of course cross-cutting concerns, that affect our whole project. +However, there are of course cross-cutting topics, that affect our whole project. -To foster these cross-cutting needs, we decided to form "Special Interest Groups", or "SIGs" in short. +To foster these needs, we decided to form "Special Interest Groups", or "SIGs" in short. SIGs From 4fc5b5a134025ac7b8c50b59b351b24d2c635539 Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Fri, 16 Feb 2024 09:51:21 +0100 Subject: [PATCH 05/10] docs(community): fix dash-licenses name --- community/sigs/02_sig_infra.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/community/sigs/02_sig_infra.md b/community/sigs/02_sig_infra.md index d7b61f9aaba..85cc7f9a7d0 100644 --- a/community/sigs/02_sig_infra.md +++ b/community/sigs/02_sig_infra.md @@ -15,6 +15,6 @@ approach, that will be based on a umbrella Chart and Helm tests. ## Dash automation A topic, every Tractus-X repo has to take care of, is legal compliance. -One of the aspects is an up-to-date `DEPENDENCIES` file, generated by [eclipse dash-license](https://github.com/eclipse/dash-licenses). +One of the aspects is an up-to-date `DEPENDENCIES` file, generated by [eclipse dash-licenses](https://github.com/eclipse/dash-licenses). SIG infra is maintaining a [run-dash](https://github.com/eclipse-tractusx/sig-infra/tree/main/.github/actions/run-dash) GitHub action, that helps to ensure the `DEPENDENCIES` file stays up-to-date. From 4cb288bcec4c44d289f179189f0048f814b64166 Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Fri, 16 Feb 2024 11:25:53 +0100 Subject: [PATCH 06/10] docs(community): remove unfinished stuff --- community/sigs/01_intro.md | 1 - 1 file changed, 1 deletion(-) diff --git a/community/sigs/01_intro.md b/community/sigs/01_intro.md index 52a1c7603df..26a5bfb5e36 100644 --- a/community/sigs/01_intro.md +++ b/community/sigs/01_intro.md @@ -7,4 +7,3 @@ All of these repositories have a very dedicated goal and focus. However, there are of course cross-cutting topics, that affect our whole project. To foster these needs, we decided to form "Special Interest Groups", or "SIGs" in short. -SIGs From 3f424d062bdd09eb5e55d9904bb2aded68e63832 Mon Sep 17 00:00:00 2001 From: ds-mkanal <100209308+mkanal@users.noreply.github.com> Date: Fri, 16 Feb 2024 13:23:07 +0100 Subject: [PATCH 07/10] doc(open-meeting): extend open meeting trace-x on 22.02.2024 --- community/open-meetings.mdx | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/community/open-meetings.mdx b/community/open-meetings.mdx index 583b93696e3..2fb95a7ca7e 100644 --- a/community/open-meetings.mdx +++ b/community/open-meetings.mdx @@ -40,7 +40,15 @@ These are dedicated sync meetings for specific products, as well as open plannin /> + + Date: Fri, 16 Feb 2024 14:28:26 +0100 Subject: [PATCH 08/10] change of the committer meeting rotation --- community/open-meetings.mdx | 2 +- static/meetings/committer-office-hour.ics | 38 +++++++++++------------ 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/community/open-meetings.mdx b/community/open-meetings.mdx index 583b93696e3..665d40225e3 100644 --- a/community/open-meetings.mdx +++ b/community/open-meetings.mdx @@ -24,7 +24,7 @@ These are dedicated sync meetings for specific products, as well as open plannin /> \nMeeting ID - : 332 054 435 962\nPasscode: bDwMjb\nDownload Teams | Join on the web\nLearn More | Meeting options\n__________________ - ______________________________________________________________\n -RRULE:FREQ=MONTHLY;UNTIL=20241230T230000Z;INTERVAL=1;BYDAY=3FR +DESCRIPTION:Open hour meeting for Eclipse Tractus-X committers. The goal of + the meeting is to discuss and share specific committer tasks/responsibili + ties.\n\n_________________________________________________________________ + _______________\nMicrosoft Teams meeting\nJoin on your computer\, mobile a + pp or room device\nClick here to join the meeting\n + Meeting ID: 332 054 435 962\nPasscode: bDwMjb\nDownload Teams | Join on the web\nLearn More | Meeting options\n________ + ________________________________________________________________________\n +RRULE:FREQ=WEEKLY;UNTIL=20241230T230000Z;INTERVAL=2;BYDAY=FR;WKST=MO UID:040000008200E00074C5B7101A82E0080000000051BBCDCF435BDA01000000000000000 010000000F334FB7EDA04724AA775688B06788E20 -SUMMARY:Committer - Office Hour +SUMMARY:Committer Meeting DTSTART:20240216T130500Z DTEND:20240216T140000Z CLASS:PUBLIC PRIORITY:5 -DTSTAMP:20240209T103620Z +DTSTAMP:20240216T131141Z TRANSP:OPAQUE STATUS:CONFIRMED LOCATION:Microsoft Teams Meeting From eaff82ed37eb068921ecaa49628f3cf0974e5184 Mon Sep 17 00:00:00 2001 From: manojava-gk Date: Mon, 19 Feb 2024 15:11:42 +0530 Subject: [PATCH 09/10] fix(kits): show arrows in slider based on the props. fix typo issue in kit usage carousel section --- src/components/RoleBasedEnrtyComponent/index.js | 5 ++--- src/pages/Kits/index.js | 2 +- utils/carouselKitdeepdive.js | 2 +- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/src/components/RoleBasedEnrtyComponent/index.js b/src/components/RoleBasedEnrtyComponent/index.js index f52d412756a..3740f137db7 100644 --- a/src/components/RoleBasedEnrtyComponent/index.js +++ b/src/components/RoleBasedEnrtyComponent/index.js @@ -24,7 +24,6 @@ import Slider from "react-slick"; import "slick-carousel/slick/slick.css"; import "slick-carousel/slick/slick-theme.css"; import Typography from '@mui/material/Typography'; -import { carouselRoleBased } from "../../../utils/carouselRoleBased"; import styles from "./styles.module.css"; import { useMediaQuery } from '@mui/material'; import ArrowCircleRightIcon from '@mui/icons-material/ArrowCircleRight'; @@ -32,7 +31,7 @@ import sliderRightArrowImage from '@site/static/img/slider_right_icon.png' import sliderLeftArrowImage from '@site/static/img/slider_left_icon.png'; import Link from "@docusaurus/Link"; -export default function RoleBasedEnrtyComponent({data}) { +export default function RoleBasedEnrtyComponent({data, showArrow = true}) { const isWeb = useMediaQuery('(min-width:1024px)'); const isMobile = useMediaQuery('(max-width:600px)'); function NextArrow (props) { @@ -70,7 +69,7 @@ export default function RoleBasedEnrtyComponent({data}) { autoplay: false, infinite: false, variableWidth: true, - arrows: true, + arrows: showArrow, nextArrow: , prevArrow: , initialSlide: 0, diff --git a/src/pages/Kits/index.js b/src/pages/Kits/index.js index 5b3ca85acbf..f48d2fa7a1e 100644 --- a/src/pages/Kits/index.js +++ b/src/pages/Kits/index.js @@ -45,7 +45,7 @@ export default function KitsPage() { >
- + Date: Mon, 19 Feb 2024 16:29:03 +0530 Subject: [PATCH 10/10] fix(service provider): update repo links in service provider page --- utils/enablementServices.js | 27 +++++++-------------------- 1 file changed, 7 insertions(+), 20 deletions(-) diff --git a/utils/enablementServices.js b/utils/enablementServices.js index d18923da1c0..c969b321ade 100644 --- a/utils/enablementServices.js +++ b/utils/enablementServices.js @@ -4,10 +4,7 @@ export const enablementServices = [ subTitle: "", productDescription: "Tractus-X EDC provides a framework for sovereign data exchange containing modules for performing data query, data exchange, policy enforcement, monitoring, and auditing.", githubRepo: [ - "https://github.com/eclipse-tractusx/bpdm", - "https://github.com/daps-helm-chart", - "https://github.com/dft-frontend", - "https://github.com/bpdm" + "https://github.com/eclipse-tractusx/tractusx-edc" ], committers: [], mailTo: "", @@ -19,10 +16,7 @@ export const enablementServices = [ subTitle: "", productDescription: "The Managed Identity Wallets (MIW) service implements the Self-Sovereign-Identity (SSI) using did:web for the Catena-X data space.", githubRepo: [ - "https://github.com/eclipse-tractusx/bpdm", - "https://github.com/eclipse-tractusx/daps-helm-chart", - "https://github.com/eclipse-tractusx/dft-frontend", - "https://github.com/eclipse-tractusx/bpdm" + "https://github.com/eclipse-tractusx/managed-identity-wallet" ], committers: [], mailTo: "", @@ -34,10 +28,7 @@ export const enablementServices = [ subTitle: "", productDescription: "The digital twin registry is used to manage and discover digital twin meta-data. Each participant must register its digital twin and relevant sub-models in the digital twin registry to expose its data offering to other participants.", githubRepo: [ - "https://github.com/eclipse-tractusx/bpdm", - "https://github.com/eclipse-tractusx/daps-helm-chart", - "https://github.com/eclipse-tractusx/dft-frontend", - "https://github.com/eclipse-tractusx/bpdm" + "https://github.com/eclipse-tractusx/sldt-digital-twin-registry" ], committers: [], mailTo: "", @@ -49,10 +40,7 @@ export const enablementServices = [ subTitle: "", productDescription: "The Item Relationship Service (IRS) builds data chains and provides custom business logic for business applications and other services", githubRepo: [ - "https://github.com/eclipse-tractusx/bpdm", - "https://github.com/eclipse-tractusx/daps-helm-chart", - "https://github.com/eclipse-tractusx/dft-frontend", - "https://github.com/eclipse-tractusx/bpdm" + "https://github.com/eclipse-tractusx/item-relationship-service", ], committers: [], mailTo: "", @@ -64,10 +52,9 @@ export const enablementServices = [ subTitle: "", productDescription: "The Managed Identity Wallets (MIW) service implements the Self-Sovereign-Identity (SSI) using did:web for the Catena-X data space.", githubRepo: [ - "https://github.com/eclipse-tractusx/bpdm", - "https://github.com/eclipse-tractusx/daps-helm-chart", - "https://github.com/eclipse-tractusx/dft-frontend", - "https://github.com/eclipse-tractusx/bpdm" + "https://github.com/eclipse-tractusx/knowledge-agents", + "https://github.com/eclipse-tractusx/knowledge-agents-aas-bridge", + "https://github.com/eclipse-tractusx/knowledge-agents-edc" ], committers: [], mailTo: "",