From ec5ee44695b69dfe89c364e620b68b9376372118 Mon Sep 17 00:00:00 2001 From: Mathias Moser Date: Fri, 28 Nov 2025 15:44:49 +0100 Subject: [PATCH 1/5] Clarify documentation for non-file entries Updated documentation to clarify that certain entries are not files and are optional links. --- docs/release/trg-10/trg-10-02.mdx | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/release/trg-10/trg-10-02.mdx b/docs/release/trg-10/trg-10-02.mdx index 00be1919bda..3b02b98db4a 100644 --- a/docs/release/trg-10/trg-10-02.mdx +++ b/docs/release/trg-10/trg-10-02.mdx @@ -103,8 +103,7 @@ The following folder structure represents a complete KIT template with all requi ```plaintext docs-kits/kits/ / - ├── README.md # Main KIT overview and quick start guide - ├── CHANGELOG.md # Version history following semantic versioning + ├── changelog.md # Version history following semantic versioning ├── adoption-view/ │ ├── _category_.json │ └── adoption-view.md # Business value, use cases, policies, standards @@ -127,10 +126,10 @@ docs-kits/kits/ │ └── my-app.md # Template for implementation success stories ├── documentation/ │ ├── _category_.json - │ ├── github-repository.md # Link to GitHub repository - │ ├── api-documentation.md # Link to API documentation - │ ├── community-support.md # Link to community support channels - │ └── related-standards.md # Links to related standards + │ ├── github-repository # NOT A FILE (OPTIONAL): External Link to GitHub repository + │ ├── api-documentation # NOT A FILE OPTIONAL: Link to API documentation + │ ├── community-support # NOT A FILE OPTIONAL: Link to community support channels + │ └── related-standards # NOT A FILE OPTIONAL: Links to related standards └── resources/ └── img/ # KIT-specific images and diagrams └── ... @@ -283,4 +282,4 @@ To ensure the quality and consistency of KITs, the following alignment mechanism | SIG-Release | Official KIT Release Tracking | [eclipse-tractusx/sig-release](https://github.com/eclipse-tractusx/sig-release) | | KIT Discussions | Offical KIT Proposal and Discussion Location | [KIT Discussions](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/discussions/categories/kits) | -In case a change to a existing KIT is planned, it is recommended to use the KIT Discussions or GitHub Issues to discuss the change with the community before starting the implementation. This will help to gather feedback and ensure alignment with other KIT developers. \ No newline at end of file +In case a change to a existing KIT is planned, it is recommended to use the KIT Discussions or GitHub Issues to discuss the change with the community before starting the implementation. This will help to gather feedback and ensure alignment with other KIT developers. From 964f5b56b7115893707db5fe12e2db956644ee6c Mon Sep 17 00:00:00 2001 From: Mathias Moser Date: Fri, 28 Nov 2025 18:14:46 +0100 Subject: [PATCH 2/5] feat: fixed some points --- docs-kits/kit-template/README.md | 6 +++--- docs/release/trg-10/trg-10-02.mdx | 22 +++++++++++++++++----- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/docs-kits/kit-template/README.md b/docs-kits/kit-template/README.md index 7271efb78ca..82fd39894ca 100644 --- a/docs-kits/kit-template/README.md +++ b/docs-kits/kit-template/README.md @@ -61,9 +61,8 @@ Add maintainers to `/.github/CODEOWNERS`: ``` kit-template/ -├── README.md # Main guide - START HERE -├── CHANGELOG.md # Version history template -├── CODEOWNERS # Maintainer assignments template +├── README.md # Main guide - START HERE (REMOVE THIS FILE BEFORE PUBLISHING) +├── changelog.md # Version history template │ ├── adoption-view/ # Business documentation (MANDATORY for all) │ ├── _category_.json @@ -94,6 +93,7 @@ kit-template/ │ └── resources/ # Images, diagrams, files img/ + └── REUSE.toml # License from each image ``` ## Maturity Levels diff --git a/docs/release/trg-10/trg-10-02.mdx b/docs/release/trg-10/trg-10-02.mdx index 3b02b98db4a..9d9b67c02df 100644 --- a/docs/release/trg-10/trg-10-02.mdx +++ b/docs/release/trg-10/trg-10-02.mdx @@ -106,7 +106,8 @@ docs-kits/kits/ ├── changelog.md # Version history following semantic versioning ├── adoption-view/ │ ├── _category_.json - │ └── adoption-view.md # Business value, use cases, policies, standards + │ ├── adoption-view.md # Business value, use cases, policies, standards + │ ├── glossary.md # You can include here more files if necessaary ├── development-view/ │ ├── _category_.json │ └── development-view.md # Architecture, API specs, semantic models, tutorials @@ -126,12 +127,14 @@ docs-kits/kits/ │ └── my-app.md # Template for implementation success stories ├── documentation/ │ ├── _category_.json + │ ├── attachments.md # Here you can include more files if necessary │ ├── github-repository # NOT A FILE (OPTIONAL): External Link to GitHub repository - │ ├── api-documentation # NOT A FILE OPTIONAL: Link to API documentation - │ ├── community-support # NOT A FILE OPTIONAL: Link to community support channels - │ └── related-standards # NOT A FILE OPTIONAL: Links to related standards + │ ├── api-documentation # NOT A FILE (OPTIONAL): Link to API documentation + │ ├── community-support # NOT A FILE (OPTIONAL): Link to community support channels + │ └── related-standards # NOT A FILE (OPTIONAL): Links to related standards └── resources/ └── img/ # KIT-specific images and diagrams + └── REUSE.toml # Declare the license from your images (See TRG 7.07) └── ... ``` @@ -154,7 +157,7 @@ This template includes detailed guidelines and examples for each section. /> -#### Only per view +#### Only one file per view In case a VIEW has only one file it shall be described in this way as a `md` or `mdx` file insice of its respective folder (using the same name of the view): @@ -172,6 +175,9 @@ In case a VIEW has multiple files it shall be described in this way as a folder ```plaintext /docs-kits/kits/ / + adoption-view/ + adoption-view.md + glossary.md development-view/ architecture.md deployment-view.mdx @@ -181,6 +187,12 @@ In case a VIEW has multiple files it shall be described in this way as a folder ... ``` +:: tip MDX Files are allowed only for advanced cases + +Use `mdx` formats only if it is necessary. + +:: + ## KIT Maintainers & Code Owners - A code owner must be set by adding to the `CODEOWNERS` at the folder path, the file is located here [`.github/CODEOWNERS`](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/.github/CODEOWNERS). From b7c7ae59353b2e1b46d25d7318f54b564a71a8bd Mon Sep 17 00:00:00 2001 From: Mathias Moser Date: Fri, 28 Nov 2025 18:17:30 +0100 Subject: [PATCH 3/5] feat: added acess& usage policies to the kit artifacts --- data/kitArtifactRequirementsData.js | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/data/kitArtifactRequirementsData.js b/data/kitArtifactRequirementsData.js index 928810a90e2..b3b2f66fb98 100644 --- a/data/kitArtifactRequirementsData.js +++ b/data/kitArtifactRequirementsData.js @@ -107,6 +107,16 @@ export const artifactRequirementsData = [ graduated: 1, additionalInfo: "Explains the Use Case (What is its context) and how it works" }, + { + artifact: "Access & Usage Policies", + view: "Adoption View", + sandbox: 0, + incubatingDraft: 3, + incubatingInProgress: 1, + incubatingInReview: 4, + graduated: 1, + additionalInfo: "In case DSP (Connector) is used, the specific policies needed for this use case need to be referenced. In case policies from other foundation KITs are use it can be avoided" + }, { artifact: "Business Processes", view: "Adoption View", From 375e541406957f4f81390d4d191130af6846f970 Mon Sep 17 00:00:00 2001 From: Mathias Moser Date: Fri, 28 Nov 2025 18:21:52 +0100 Subject: [PATCH 4/5] feat: Clarify comments on external links in documentation Updated comments for clarity regarding external links. --- docs/release/trg-10/trg-10-02.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/release/trg-10/trg-10-02.mdx b/docs/release/trg-10/trg-10-02.mdx index 9d9b67c02df..5724af325ea 100644 --- a/docs/release/trg-10/trg-10-02.mdx +++ b/docs/release/trg-10/trg-10-02.mdx @@ -128,9 +128,9 @@ docs-kits/kits/ ├── documentation/ │ ├── _category_.json │ ├── attachments.md # Here you can include more files if necessary - │ ├── github-repository # NOT A FILE (OPTIONAL): External Link to GitHub repository + │ ├── github-repository # NOT A FILE (OPTIONAL): External Link to GitHub │ ├── api-documentation # NOT A FILE (OPTIONAL): Link to API documentation - │ ├── community-support # NOT A FILE (OPTIONAL): Link to community support channels + │ ├── community-support # NOT A FILE (OPTIONAL): Link to community channels │ └── related-standards # NOT A FILE (OPTIONAL): Links to related standards └── resources/ └── img/ # KIT-specific images and diagrams From 055f2cf1a15936479e35a3654fde0b9c274e0edb Mon Sep 17 00:00:00 2001 From: Mathias Moser Date: Mon, 1 Dec 2025 12:15:41 +0100 Subject: [PATCH 5/5] Update docs/release/trg-10/trg-10-02.mdx MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Johann Schütz <147107265+jSchuetz88@users.noreply.github.com> --- docs/release/trg-10/trg-10-02.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release/trg-10/trg-10-02.mdx b/docs/release/trg-10/trg-10-02.mdx index 5724af325ea..8c68edcf618 100644 --- a/docs/release/trg-10/trg-10-02.mdx +++ b/docs/release/trg-10/trg-10-02.mdx @@ -294,4 +294,4 @@ To ensure the quality and consistency of KITs, the following alignment mechanism | SIG-Release | Official KIT Release Tracking | [eclipse-tractusx/sig-release](https://github.com/eclipse-tractusx/sig-release) | | KIT Discussions | Offical KIT Proposal and Discussion Location | [KIT Discussions](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/discussions/categories/kits) | -In case a change to a existing KIT is planned, it is recommended to use the KIT Discussions or GitHub Issues to discuss the change with the community before starting the implementation. This will help to gather feedback and ensure alignment with other KIT developers. +In case a change to an existing KIT is planned, it is recommended to use the KIT Discussions or GitHub Issues to discuss the change with the community before starting the implementation. This will help to gather feedback and ensure alignment with other KIT developers.