### Install Dependencies and Start Local Development Server

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/README.md

Run these commands to install necessary packages and start the local development server for viewing documentation.

```bash
npm install
```

```bash
npm start
```

--------------------------------

### Clone Repository and Start with Docker Compose

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits_versioned_docs/version-26.03/kit-template/graduated/operations-view/operations-view.md

Clone the repository and start the application using Docker Compose. Ensure Docker is installed and running.

```bash
git clone https://github.com/eclipse-tractusx/[repository-name].git
cd [repository-name]
docker-compose up -d
```

--------------------------------

### README.md TL;DR Example

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs/release/trg-5/trg-5-02.md

Example of the 'TL;DR' section in a README.md file, providing quick Helm commands for adding a repository and installing a chart.

```shell
helm repo add [REPO_URL] oci://registry-1.docker.io/cloudpirates
helm install my-release my-repo/postgresql
```

--------------------------------

### Shell + Curl Example

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits_versioned_docs/version-26.03/kits/knowledge-agents-kit/software-development-view/api/agent/get.mdx

Demonstrates how to use curl to make a GET request to the agent API. This example includes all possible query parameters for invoking a skill or query.

```shell
curl --request GET \
  --url 'https://knowledge.dev.demo.catena-x.net/consumer-edc-data/BPNL00000003CQI9/api/agent?asset=SOME_STRING_VALUE&runMode=SOME_STRING_VALUE&queryLn=SOME_STRING_VALUE&query=SOME_STRING_VALUE&(vin=SOME_STRING_VALUE&troubleCode=SOME_ARRAY_VALUE'
```

--------------------------------

### README.md Prerequisites Example

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs/release/trg-5/trg-5-02.md

Example of the 'Prerequisites' section in a README.md file, specifying required software and versions.

```markdown
- Kubernetes 1.19+
- Helm 3.2.0+
- PV provisioner support in the underlying infrastructure
```

--------------------------------

### Multi-Stage Dockerfile Build Example

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs/release/trg-4/trg-4-02.md

This example demonstrates a multi-stage Dockerfile build. The first stage (BUILDER) uses a specific Alpine version and installs curl to download a tool. The second stage uses a clean Eclipse Temurin JRE image and copies the downloaded tool from the builder stage, resulting in a smaller final image.

```Dockerfile
FROM alpine:3.18 as BUILDER

ENV DOWLOAD_URL "https://some-fqdn/tool.jar"

RUN apk update && apk add curl=8.5.0-r0 --no-cache
RUN curl -L --proto "=https" -sSf ${DOWLOAD_URL} \
    --output /tmp/tool.jar

FROM eclipse-temurin:19-jre-alpine

COPY --from=otel /tmp/tool.jar .

[...]
```

--------------------------------

### Build and Install BPDM Applications

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits_versioned_docs/version-26.03/kits/business-partner-kit/software-development-view/use-cases.md

Compile and install all BPDM applications using Maven. This command cleans previous builds and installs the artifacts into the local Maven repository.

```bash
mvn clean install
```

--------------------------------

### HTTP GET Request Example

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits_versioned_docs/version-26.03/kit-template/graduated/development-view/development-view.md

Example of an HTTP GET request to retrieve resources, including necessary headers like Host and Authorization.

```http
GET /v1/resources HTTP/1.1
Host: api.example.com
Authorization: Bearer <token>
```

--------------------------------

### Build and Serve Project

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/community/intro.md

Run these commands to build the project and serve it locally for testing after adding a new meeting. Verify the meeting appears correctly in the UI and calendar.

```bash
npm run build
npm run serve
```

--------------------------------

### Configure User Permissions for Tutorial

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs/tutorials/e2e/prerequisites/prerequisites.md

Grant a user the necessary permissions to run the tutorial, including membership in the 'docker' group and write access to /etc/hosts. This allows users to manage their own environments with minimal privileges.

```bash
sudo adduser tx01 docker
```

```bash
sudo chgrp docker /etc/hosts
```

```bash
sudo chmod 664 /etc/hosts
```

--------------------------------

### Install Helm Chart

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs/release/trg-1/trg-1-02.md

Install the 'product-example' Helm chart into your Kubernetes cluster using a specified release name. Ensure the Helm repository has been added prior to execution.

```shell
helm install helm-release-name tractusx-dev/product-example
```

--------------------------------

### JSON Response Example for GET /resources

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits_versioned_docs/version-26.03/kit-template/graduated/development-view/development-view.md

A sample JSON response for a GET request to retrieve resources, detailing the structure of the returned resource list.

```json
{
  "resources": [
    {
      "id": "resource-1",
      "name": "Example Resource",
      "type": "data-asset"
    }
  ]
}
```

--------------------------------

### Example Filesystem Structure for .license files

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs/release/trg-7/trg-7-07.md

This shell snippet illustrates a recommended directory structure for managing licenses using `.license` files alongside assets like images.

```shell
project/
|__ docs/
|   |__ adoption-view.md
|   |__ img/
|      |__ image1.jpg
|      |__ image1.jpg.license
|      |__ image2.png
|      |__ image2.png.license
|__ LICENSE
|__ LICENSE_non-code
```

--------------------------------

### SoftwareInformation Aspect Model Example

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits_versioned_docs/version-26.03/kits/traceability-kit/software-development-view/parts/aspect-models.mdx

Example of the SoftwareInformation aspect model, which details software components installed on a part. It includes fields for Catena-X ID, software name, ID, version, and last modification date.

```json
{
  "catenaXId": "urn:uuid:454ffa8e-f88d-4ad1-be45-06981756aeb1",
  "softwareInformation": [
    {
     "name": "ECU Software XY12345",
      "softwareId": "SW123456789",
      "version": "1.2.0",
      "lastModifiedOn": "2023-03-21T08:17:29.187+01:00"
    },
    {
      "name": "Controller-SW",
   	  "softwareId": "SW987654321",
      "version": "3.0.0",
      "lastModifiedOn": "2024-04-30T08:17:29.187+01:00"
    }
  ]
}
```

--------------------------------

### PlantUML Diagram Code

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs/release/trg-1/trg-1-04.md

Example of a PlantUML script to generate a diagram. Ensure PlantUML is installed or use an online service for rendering.

```plantuml
@startuml
(First usecase)
(Another usecase) as (UC2)
usecase UC3
usecase (Last\nusecase) as UC4
@enduml
```

--------------------------------

### Assign Asset Properties

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits_versioned_docs/version-26.03/kits/model-based-development-and-data-processing-kit/software-development-view.md

Example of assigning asset properties to an asset of type Asset with a specific ID. Property names must start with 'asset:'.

```json
"asset": {

        "@type": "Asset",

        "@id": "2",

        "properties": {

        "asset:prop:id": "2",

        "asset:prop:description": "FMU thermal model of powertrain ABXYZ",

        "asset:ToolVersion": "3.5"

        }

}

```

--------------------------------

### Add Documentation File

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs/website-guidelines/kit-structure.md

Add a `documentation.md` file to house general documentation for the KIT.

```markdown
root
    └── docs-kits
        └── kits
            └── new-kit
                ├── changelog.md
                ├── adoption-view.md
                ├── software-development.md
                ├── software-operation-view.md
                └── documentation.md
```

--------------------------------

### Create KIT Documentation Folder Structure

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/wiki/How-to-create-a-KIT-website?

Follow this directory structure to organize your new KIT documentation.

```bash
root
|--docs-kits
   |--kits
      |--NewKIT
```

```bash
root
|--docs-kits
   |--kits
      |--NewKIT
         |--page_adoption-view.md
```

```bash
root
|--docs-kits
   |--kits
      |--NewKIT
         |--page_adoption-view.md
         |--page_software-operation-view.md
```

```bash
root
|--docs-kits
   |--kits
      |--NewKIT
         |--page_adoption-view.md
         |--page_software-operation-view.md
         |--page_documentation.md
```

```bash
root
|--docs-kits
   |--kits
      |--NewKIT
         |--page_adoption-view.md
         |--page_software-operation-view.md
         |--page_documentation.md
         |--Software Development View
            |--page_software-development-view.md
```

--------------------------------

### Get Production Tracking Request (Part Instance ID)

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits_versioned_docs/version-26.03/kits/modular-production-kit/software-development-view/software-development-view.md

Example JSON request for GetProductionTracking using a PartInstanceId. This format is used when identifying a product by its specific instance.

```json
{
    "header": {
      "senderBpn": "BPNL1234567890SE",
      "expectedResponseBy": "2023-06-19T21:24:00+07:00",
      "context": "urn:samm:io.catenax.shopfloor_information.get_production_tracking:1.0.0",
      "messageId": "3b4edc05-e214-47a1-b0c2-1d831cdd9ba9",
      "receiverBpn": "BPNL7588787849VT",
      "sentDateTime": "2023-06-19T21:24:00+07:00",
      "version": "2.0.0"
    },
    "request": {
      "identifierNumber": "box-12345678",
      "stepIdentifierList": [
          {
            "processParameterList": [
                {
                  "processParameterSemanticId": "0173-1#02-ABK233#001",
                  "processParameterName": "Drehmoment_Max"
                }
            ],
            "capabilityId": "Fuegen.Anpressen_Einpressen.Schrauben.Deckelverschrauben",
            "partInstanceLevel": "partInstanceId",
            "partInstanceId": "Deckel-Serial-123"
          }
      ],
      "customerId": "550e8400-e29b-41d4-a716-446655440000",
      "identifierType": "partInstanceId",
      "version": "1.0.0",
      "processReferenceType": "capability"
    }
}
```

--------------------------------

### Get Production Tracking Request (Bill of Process)

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits_versioned_docs/version-26.03/kits/modular-production-kit/software-development-view/software-development-view.md

Example JSON request for GetProductionTracking using a Bill of Process ID. This format is used when identifying a product by its manufacturing process.

```json
{
    "header": {
      "senderBpn": "BPNL1234567890SE",
      "expectedResponseBy": "2023-06-19T21:24:00+07:00",
      "context": "urn:samm:io.catenax.shopfloor_information.get_production_tracking:1.0.0",
      "messageId": "3b4edc05-e214-47a1-b0c2-1d831cdd9ba9",
      "receiverBpn": "BPNL7588787849VT",
      "sentDateTime": "2023-06-19T21:24:00+07:00",
      "version": "2.0.0"
    },
    "request": {
      "identifierNumber": "box-12345678",
      "stepIdentifierList": [
          {
            "processStepId": "Fuegen.Anpressen_Einpressen.Schrauben.Deckelverschrauben_01",
            "processParameterList": [
                {
                  "processParameterSemanticId": "0173-1#02-ABK233#001",
                  "processParameterName": "Drehmoment_Max"
                }
            ]
          }
      ],
      "customerId": "550e8400-e29b-41d4-a716-446655440000",
      "identifierType": "partInstanceId",
      "billOfProcessId": "box-with-lid-12345678-bill-of-process",
      "version": "1.0.0",
      "processReferenceType": "processStep"
    }
}
```

--------------------------------

### Install kubectl using Snap

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs/tutorials/e2e/prerequisites/prerequisites.md

Installs kubectl using snap with the 'classic' security policy. This policy grants broader system access, which may be necessary for certain snap functionalities.

```bash
sudo snap install kubectl --classic
```

--------------------------------

### Copy KIT Documentation to Website Directory

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs/website-guidelines/automate-kit-doc-update.md

This script creates a directory for the KIT's documentation within the main repository and copies the documentation files. Ensure the source path '<repo name>/path/to/documentation' is correct for your KIT.

```bash
run: |
            # create path for the KIT Repository
            mkdir -p main-repo/docs/test-kit &&
            # copy documentation to website
            cp -r <repo name>/path/to/documentation main-repo/docs/<repo name>
```

--------------------------------

### Catena-X Dataspace Example

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/documentation/kit-master-data-overview.mdx

An example configuration for the Catena-X dataspace, showcasing specific values for its branding, colors, and associated KITs.

```javascript
{
  name: "Catena-X",
  url: "https://catena-x.net/",
  gradient: 'linear-gradient(135deg, #ffa600, #b3cb2d)',
  logo: {
    src: 'https://catena-x.net/wp-content/uploads/2025/10/CX_Figurative_mark_RGB_pos.png',
    alt: 'Catena-X Logo',
    width: 70,
    height: 70
  },
  colors: {
    layer1: 'rgb(110, 200, 105)',
    layer2: 'rgb(179, 203, 45)',
    layer3: 'rgb(230, 163, 38)',
    layer4: 'rgb(250, 160, 35)'
  },
  subtitle: 'Your Automotive Network',
  description: 'The first open and collaborative data ecosystem for the automotive industry...',
  kits: ['connector', 'data-governance', 'business-partner', ...]
}
```

--------------------------------

### Invoke a Locally-Stored Parameterized Skill (Simple)

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits_versioned_docs/version-26.03/kits/knowledge-agents-kit/software-development-view/api.md

This example demonstrates how to invoke a locally-stored parameterized skill using the AGENT GET method. It shows a curl command to query for vehicle lifetime information based on VIN and trouble codes.

```APIDOC
## AGENT GET

### Description
Invokes a locally-stored parameterized skill.

### Method
GET

### Endpoint
/agent

### Parameters
#### Query Parameters
- **asset** (string) - Required - The asset identifier for the skill.
- **(vin=..., troubleCode=...)** (string) - Required - Parameter key-value pairs for the skill.

### Request Example
```console
curl --location '${KA-MATCH}/agent?asset=urn%3Acx%3ASkill%3Aconsumer%3ALifetime&(vin=WBAAL31029PZ00001&troubleCode=P0746&troubleCode=P0745)&(vin=WBAAL31029PZ00002&troubleCode=P0744)&(vin=WBAAL31029PZ00003&troubleCode=P0743)' \
--header 'Authorization: Basic ${UuencodedUsernameColonPassword}'
```
```

--------------------------------

### Install Python Dependencies

Source: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/scripts/README.md

Installs the necessary Python packages for the documentation generation scripts. Ensure you have Python 3.11 or higher installed.

```bash
pip install -r scripts/requirements.txt
```