Merge pull request #1 from catenax-ng/feat/kit-template

Use KIT Template for Traceability Documentation
eclipse-tractusx · Feb 28, 2023 · 4ace462 · 4ace462
2 parents 06b8dab + 1ab4536
commit 4ace462
Show file tree

Hide file tree

Showing 5 changed files with 109 additions and 0 deletions.
diff --git a/docs/kits/Template Kit/Software Development View/page_software-development-view.md b/docs/kits/Template Kit/Software Development View/page_software-development-view.md
@@ -0,0 +1,22 @@
+---
+id: Development View Template Kit
+title: Development View
+description: 'Template Kit'
+sidebar_position: 3
+---
+
+<!--
+Development View of the Kit.
+-->
+
+<!-- !Mandatory! -->
+## API Specifications
+
+<!-- Recommended -->
+## Sample Data
+
+<!-- Recommended -->
+## Reference Implementation
+
+<!-- Recommended -->
+## Documentation in the Context of Development
diff --git a/docs/kits/Template Kit/page_adoption-view.md b/docs/kits/Template Kit/page_adoption-view.md
@@ -0,0 +1,37 @@
+---
+id: Adoption View Template Kit
+title: Adoption View
+description: 'Template Kit'
+sidebar_position: 1
+---
+
+<!--
+Adoption View of the Kit.
+-->
+
+<!-- !Mandatory! -->
+## Vision & Mission
+
+<!-- !Mandatory! -->
+## Business Value
+
+<!-- !Mandatory! -->
+## Use Case
+
+<!-- Recommended -->
+## Tutorials
+
+<!-- Optional -->
+## Whitepaper
+
+<!-- Recommended -->
+## Semantic Models
+
+<!-- Recommended -->
+## Logic & Schema
+
+<!-- Recommended -->
+## Business Process
+
+<!-- !Mandatory! -->
+## Standards
diff --git a/docs/kits/Template Kit/page_documentation.md b/docs/kits/Template Kit/page_documentation.md
@@ -0,0 +1,10 @@
+---
+id: Documentation Template Kit
+title: Documentation
+description: 'Template Kit'
+sidebar_position: 3
+---
+
+<!--
+Documentation of the Kit.
+-->
diff --git a/docs/kits/Template Kit/page_software-operation-view.md b/docs/kits/Template Kit/page_software-operation-view.md
@@ -0,0 +1,26 @@
+---
+id: Operation View Template Kit
+title: Operation View
+description: 'Template Kit'
+sidebar_position: 2
+---
+
+<!--
+Documentation of the Kit.
+-->
+
+## Quick Setup Guide
+
+| Step                                               | Action                                                             | Description                                                                              |
+|----------------------------------------------------|--------------------------------------------------------------------|------------------------------------------------------------------------------------------|
+| ![arrow down](../../../static/img/arrow_down.png)  | **[Install the prerequisites](#step-1-install-the-prerequisites)** | Install all necessary tools for this setup.                                              |
+| ![vector](../../../static/img/vector.png)          | **[Get Helm Chart](#step-2-get-helm-charts)**                      | Get all necessary code to deploy the service and dependencies to the Kubernetes cluster. |
+| ![check](../../../static/img/check.png)            | **[Start the Environment](#step-3-start-the-environment)**         | Start cluster and interact with the KIT.                                                 |
+
+### Step 1: Install the Prerequisites
+
+### Step 2: Get Helm Charts
+
+### Step 3: Start the Environment
+
+## Deployment Scripts
diff --git a/sidebars.js b/sidebars.js
@@ -123,6 +123,20 @@ const sidebars = {
 
             ],
         },
+        {
+            type: 'category',
+            label: 'Template Kit',
+            link: {
+                type: 'generated-index',
+            },
+            collapsed: true,
+            items: [
+                {
+                    type: 'autogenerated',
+                    dirName: 'kits/Template Kit',
+                },
+            ],
+        },
     ],
 };