Skip to content

Create Getting-started-template.md #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: stage
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions source/installation-guide/Getting-started-template.md
Original file line number Diff line number Diff line change
@@ -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}