Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions data/kitArtifactRequirementsData.js
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
6 changes: 3 additions & 3 deletions docs-kits/kit-template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -94,6 +93,7 @@ kit-template/
└── resources/ # Images, diagrams, files
img/
└── REUSE.toml # License from each image
```

## Maturity Levels
Expand Down
29 changes: 20 additions & 9 deletions docs/release/trg-10/trg-10-02.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,11 @@ The following folder structure represents a complete KIT template with all requi
```plaintext
docs-kits/kits/
<kit-name>/
├── 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
│ ├── 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
Expand All @@ -127,12 +127,14 @@ 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
│ ├── attachments.md # Here you can include more files if necessary
│ ├── 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 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)
└── ...
```

Expand All @@ -155,7 +157,7 @@ This template includes detailed guidelines and examples for each section.
/>
</div>

#### 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):

Expand All @@ -173,6 +175,9 @@ In case a VIEW has multiple files it shall be described in this way as a folder
```plaintext
/docs-kits/kits/
<kit-name>/
adoption-view/
adoption-view.md
glossary.md
development-view/
architecture.md
deployment-view.mdx
Expand All @@ -182,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).
Expand Down Expand Up @@ -283,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 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.