From adbb6e0d86161fcea6886d721e687549484af1d5 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Thu, 1 Feb 2024 12:25:30 +0100
Subject: [PATCH] Create Getting-started-template.md

A template with some example content to start filling in the details relevant for deploying OS2Iot on a local machine.
---
 .../Getting-started-template.md               | 71 +++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 source/installation-guide/Getting-started-template.md

diff --git a/source/installation-guide/Getting-started-template.md b/source/installation-guide/Getting-started-template.md
new file mode 100644
index 0000000..067b5fb
--- /dev/null
+++ b/source/installation-guide/Getting-started-template.md
@@ -0,0 +1,71 @@
+
+# Title
+
+Intro
+
+## What you'll need
+
+🕜 xx minutes
+
+🗄️ A git repository
+
+📦   Some services packed as OCI containers
+
+☸️  A cluster with container orchestration
+
+🔎 A way to monitor and observe the deployment
+
+## 🗺️ Overview of moving parts
+
+```mermaid
+---
+title: High level architecture template
+config:
+  theme: default
+  themeVariables:
+---
+graph LR;
+ client([client])-.->service[Frontend Service];
+ subgraph cluster
+ service-->service2[Backend Service]
+ service2-->service3[(dbservice)]-->service2
+ end
+ classDef plain fill:#ddd,stroke:#fff,stroke-width:4px,color:#000;
+ classDef k8s fill:#326ce5,stroke:#fff,stroke-width:4px,color:#fff;
+ classDef cluster fill:#fff,stroke:#bbb,stroke-width:2px,color:#326ce5;
+ class ingress,service,pod1,pod2 k8s;
+ class client plain;
+ class cluster cluster;
+```
+
+## ⬇️ Installation steps
+
+Short intro explaining in value terms, what you have when youre done following the steps..
+
+### 1️⃣ - One-sentence description of the step
+
+{Optionally, introduce this section with brief explanatory text.}
+
+Instructions
+
+{Optional: include a code snippet or relevant screenshot that helps your users complete the steps.}
+
+{Optional: show the result of completing this step, such as a text output or an image).}
+
+### 2️⃣  - One-sentence description of the step
+
+{Optionally, introduce this section with brief explanatory text.}
+
+Instructions
+
+{Optional: include a code snippet or relevant screenshot that helps your users complete the steps.}
+
+{Optional: show the result of completing this step, such as a text output or an image).}
+
+### 🔚  Post installation
+
+{Provide an overview of options or link to other relevant documentation once installation has been completed. Also, account for anticipated problems during or after installation.}
+
+### 🚨  Troubleshooting
+
+{Provide an overview of typical errors and ways to get around them}