Skip to main content

KIT Getting started

StatusCreatedPost-History
Draft04-Apr-2024Initial contribution
Active07-Nov-2025Extended Contribution to KITs 2.0

Welcome to the Eclipse Tractus-X KITs Getting Started Guide! This guide is designed to help you understand what KITs are, how to get started with them, and how to create your own KITs for the Eclipse Tractus-X ecosystem.

What is a KIT?​

KIT Framework OverviewKIT Framework Overview

KIT, short for Keep It Together, is an open-source toolbox with comprehensive documentation that enables multiple stakeholders (Business, Solution Providers, Developers) to build interoperable applications compatible with the Eclipse Tractus-X dataspace technologies, support the compliance with industrial standards from standarization organizations (Catena-X e.V., IDTA, ISO/DIN, EDWG, Manufacturing-X, etc.) and in some use cases enable also regulatory compliance.

First Steps​

Take your first steps on creating your KIT by following this guide. Here you will find detailed step by step explanations from ZERO TO KIT. More information can be found in other pages:

KIT Framework Guide
Understand the KIT structure, artefacts and requirements.
KIT Lifecycle Guide
Understand how KITs are released, quality metrics and maintained.
KIT Master Data Overview
Complete KIT metadata and statistics.
KIT Statistics & Analytics
Analyze KIT data, state of life and development metrics.

Prerequisites​

You need to have a Github Account and to fulfill the requirements from the Developer Hub Getting Started Guide.

Contact & Support​

Get informed about what are the KITs and how to contribute by reaching out to the KITs Program Manager or attending our KIT community office hours:

Mathias Moser

Mathias Moser

KITs Program Manager
Eclipse Tractus-X Project Lead
EmailGitHubMatrix

Community Channels​

ChannelPurposeLink
KIT Community Office HoursWeekly alignment meetingsJoin Meeting
KIT Office Hour KanbanDevelopment items trackingGithub Project
Matrix ChatDaily discussions & support#tractusx-kits:matrix.eclipse.org
GitHub IssuesTechnical issues & bugsCreate Issue
SIG-ReleaseOfficial KIT Release Trackingeclipse-tractusx/sig-release
KIT DiscussionsOffical KIT Proposal and Discussion LocationKIT Discussions

KIT Template​

KIT Framework OverviewKIT Framework Overview

Follow the KIT template to have an example of folder structure that can be followed following the KIT Framework Guide and the needed content for each view in order to achieve all requirements from the KIT Lifecycle.

How to Create a KIT​

Quick Overview​

Detailed Step by Step Process (click to expand)

Step 1: Create/Discuss Idea​

Talk to the community about your KIT concept.

What to bring: Brief description of your use case and target audience.

Detailed Process Mapping
This step is optional but highly recommended for alignment and early feedback.
Step 1: Formalize/Discuss Idea in Discussions

Step 2: Create SIG-Release Ticket​

Create an official tracking ticket.

  1. Go to eclipse-tractusx/sig-release
  2. Create new issue using "Propose KIT" template
  3. Fill in your KIT description and team members
Detailed Process Mapping
These steps establish official tracking and community visibility for your KIT.
Step 2: Create Ticket in sig-releaseStep 3: Present ticket in Open Planning

Step 3: Build Your KIT​

Create your KIT following the standard structure.

Follow this structure:

ViewsStakeholdersContent
Adoption ViewBusinessBusiness Value, Motivation, Vision, Mission, Whitepapers, Semantic Models, Standards, Tutorials, Explanations why this use case is important, Context
Development ViewDevelopersArchitectsOverall Architecture, Reference Implementations, API specifications, Policies, Algorithms, Functional Requirements, Sequence Diagrams, Process, Architecture Guidelines
Operator ViewOperatorsService ProvidersNon-Functional Requirements, Security Requirements, Recommendations, Restrictions
DocumentationAny StakeholderExtra Documentation and Links
Success StoriesOperatorsService ProvidersBusinessSuccess Stories from Reference Implementations that used this KIT. Open Source and COTS.
Industry ExtensionsDataspace AdoptersOne Folder per Industry. Extends the contents from the other views with regards to a specific industry and affiliated dataspace standards/requirements
Generic Requirements for All KITs

In addition to the view-specific content above, every KIT must include:

  • Copyright Notice - Mandatory CC-BY-4.0 licensing information and contributor copyright statements at every file
  • Changelog - Version history file following semantic versioning

The views above are organized in "folders" so that its sections are harmonized and the content from each view remains flexible.

Detailed Process Mapping
This is where you create the actual KIT content in your forked repository.
Step 4: Build KIT in your fork

Step 4: Submit for Review​

Submit your completed KIT for community review.

  1. Fork eclipse-tractusx.github.io
  2. Add your KIT to the master data
  1. Add your KIT in this file by updating the sidebar configuration in '/sidebarsDocsKits.js' at the root folder (a template will be provided).
  2. Update the docusaurus.config.js file to include your new KIT at the navbar, search for navbar: { items: [{type: 'dropdown', label: 'KITs', position: 'left', to: '/Kits', items: [...] }
  3. Update the changelog with what was added
  4. Create a pull request to eclipse-tractusx.github.io main branch
  5. Request the committer assigned in the SIG-Release ticket to review, approve and merge your PR

Timeline: Typically 2-3 weeks from submission to approval.

Detailed Process Mapping
The final phase involves submission, review, and official publication of your KIT.
Step 5: Submit PR with changelog + master dataStep 6: Get PR approved by committerStep 7: KIT published in release changelogs

Step 5: Release your KIT (Committers)​

  1. The committer MUST create a release check issue at sig-release based on the KIT Release template
  2. The committer MUST ensure all TRGs metadata is checked in the release check issue.
  3. Changelog is included in the Project Release Notes of the target release
  4. KIT will be listed as part of the release notes on the Eclipse Tractus-X Website

Congratulations! Your KIT is now part of the Eclipse Tractus-X ecosystem!

Additional Resources​

KIT Documentation​

Documentation References​

KIT-Specific TRGs (Tractus-X Release Guidelines)​

Legal & Licensing​