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}