From b1fc01d38dd4cb27843c12357336b94086639916 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Thu, 13 Jun 2024 17:39:34 +0200
Subject: [PATCH 01/17] First draft added.. GitOps placeholder still missing

---
 HOW-TO-DEPLOY.MD | 54 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 HOW-TO-DEPLOY.MD

diff --git a/HOW-TO-DEPLOY.MD b/HOW-TO-DEPLOY.MD
new file mode 100644
index 0000000..c23d596
--- /dev/null
+++ b/HOW-TO-DEPLOY.MD
@@ -0,0 +1,54 @@
+# How to Deploy
+
+## Introduction
+
+Welcome to the deployment guide for [OS2-PROJECTNAME]. This document will walk you through the process of deploying pre-built containers, whether you're setting up a development environment or deploying to a production cluster.
+
+## Prerequisites
+
+Before proceeding with the deployment, please ensure you have the following prerequisites met:
+
+- Docker or Podman installed for local container management.
+- Access to the [OS2-PROJECTNAME] container images.
+- For production deployments:
+  - Access to the Kubernetes cluster where you will deploy the application.
+  - **For Helm users**: Helm package manager installed. If you do not have Helm installed, please refer to the official Helm installation guide.
+
+## 💻 Development
+
+To set up a containerized development and test environment you can use the `docker run` or `podman run` to pull the containerimage and run the container.
+
+### Docker
+```shell
+docker run -d -p {CONTAINERPORT:HOSTPORT} --name {CONTAINER_NAME} {IMAGE_NAME}:{TAG}
+```
+[Official documentation for `docker run`](https://docs.docker.com/reference/cli/docker/container/run/)
+
+### Podman
+```shell
+podman run -d -p {HOSTPORT}:{CONTAINERPORT} --name {CONTAINER_NAME} {IMAGE_NAME}:{TAG}
+```
+[Official documentation for `podman run`](https://docs.podman.io/en/latest/markdown/podman-run.1.html)
+
+
+## 🚢 Production
+
+To deploy [OS"-PROJECTNAME] to production use the supplied templates in the deployment-repository here: {DEPLOYMENTREPO-URL}
+
+### 🌐 Manual push deployment with Helm
+
+Manual push deployments involve a developer or an operator directly deploying changes to a Kubernetes cluster using tools like the Helm package manager. 
+
+To manually push a deployment to a Kubernetes cluster with the chart from the {DEPLOYMENTREPO-URL}, you can use the `helm install` command.
+
+Here's a basic example:
+
+```shell
+helm install {RELEASE_NAME} {CHART_PATH} --values {VALUES_FILE}
+```
+[Official documentation for `helm install`](https://helm.sh/docs/helm/helm_install/#helm)
+
+For detailed information on the Helm chart structure and syntax, you can refer to the [Helm Charts documentation](https://helm.sh/docs/topics/charts/).
+
+### Automatic push deployment with GitOps tools
+

From f3716380098d07a3f4608ac2cbe1d7529a384681 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Thu, 13 Jun 2024 20:34:59 +0200
Subject: [PATCH 02/17] Added Cluster deployment

---
 HOW-TO-DEPLOY.MD | 61 ++++++++++++++++++++++++++++++++----------------
 1 file changed, 41 insertions(+), 20 deletions(-)

diff --git a/HOW-TO-DEPLOY.MD b/HOW-TO-DEPLOY.MD
index c23d596..641cf29 100644
--- a/HOW-TO-DEPLOY.MD
+++ b/HOW-TO-DEPLOY.MD
@@ -4,27 +4,22 @@
 
 Welcome to the deployment guide for [OS2-PROJECTNAME]. This document will walk you through the process of deploying pre-built containers, whether you're setting up a development environment or deploying to a production cluster.
 
-## Prerequisites
+## 💻 Development
+To set up a containerized development and test environment on a local computer or in a hosted developer enviroment like GitHub codespaces, you can use the `docker run` or `podman run` to pull the containerimage and run the container.
 
-Before proceeding with the deployment, please ensure you have the following prerequisites met:
+### Prerequisites
 
 - Docker or Podman installed for local container management.
 - Access to the [OS2-PROJECTNAME] container images.
-- For production deployments:
-  - Access to the Kubernetes cluster where you will deploy the application.
-  - **For Helm users**: Helm package manager installed. If you do not have Helm installed, please refer to the official Helm installation guide.
-
-## 💻 Development
 
-To set up a containerized development and test environment you can use the `docker run` or `podman run` to pull the containerimage and run the container.
 
-### Docker
+### 🗳️ Docker example
 ```shell
 docker run -d -p {CONTAINERPORT:HOSTPORT} --name {CONTAINER_NAME} {IMAGE_NAME}:{TAG}
 ```
 [Official documentation for `docker run`](https://docs.docker.com/reference/cli/docker/container/run/)
 
-### Podman
+### 🐭 Podman example
 ```shell
 podman run -d -p {HOSTPORT}:{CONTAINERPORT} --name {CONTAINER_NAME} {IMAGE_NAME}:{TAG}
 ```
@@ -33,22 +28,48 @@ podman run -d -p {HOSTPORT}:{CONTAINERPORT} --name {CONTAINER_NAME} {IMAGE_NAME}
 
 ## 🚢 Production
 
-To deploy [OS"-PROJECTNAME] to production use the supplied templates in the deployment-repository here: {DEPLOYMENTREPO-URL}
+### Deployment on a single host
+For less demanding production environments on a single VM or bare metal host, you can use tools like Ansible, Chef, or Puppet to deploy the container.
 
-### 🌐 Manual push deployment with Helm
+### Prerequisites
 
-Manual push deployments involve a developer or an operator directly deploying changes to a Kubernetes cluster using tools like the Helm package manager. 
+- Ansible installed for server configuration management.
+- Access to the [OS2-PROJECTNAME] container images in a registry.
+- A user account on the remote host with sufficient privileges to execute Ansible commands.
+- SSH keys for passwordless login between your local machine and the remote host. This involves generating an SSH key pair and adding the public key to the `authorized_keys` file on the remote host.
+- Properly configured environment variables and volumes for production use.
 
-To manually push a deployment to a Kubernetes cluster with the chart from the {DEPLOYMENTREPO-URL}, you can use the `helm install` command.
-
-Here's a basic example:
+### 🅰️ Ansible Example
+Use the following command to run `ansible-pull` from your local machine on the remote host via SSH:
 
 ```shell
-helm install {RELEASE_NAME} {CHART_PATH} --values {VALUES_FILE}
+ssh remote_user@remote_host "ansible-pull -U https://github.com/{USERNAME}/{REPOSITORY}.git \\
+             -e 'container_port={CONTAINERPORT}' \ 
+             -e 'host_port={HOSTPORT}' \          
+             -e 'container_name={CONTAINER_NAME}' \ 
+             -e 'image_name={IMAGE_NAME}' \ 
+             -e 'tag={TAG}'"
 ```
-[Official documentation for `helm install`](https://helm.sh/docs/helm/helm_install/#helm)
 
-For detailed information on the Helm chart structure and syntax, you can refer to the [Helm Charts documentation](https://helm.sh/docs/topics/charts/).
+---
+
+### 🌐 Cluster Deployment
+For more demanding production environments that require scalability, fault tolerance, observability and high availability container orchestration tools like [Kubernetes](https://kubernetes.io/), [Nomad](https://www.hashicorp.com/products/nomad), [OpenShift](https://www.openshift.com/) is recommended alongside [GitOps](https://opengitops.dev/) tools like [ArgoCD](https://argoproj.github.io/argo-cd/), [Flux](https://fluxcd.io/) or [Fleet](ttps://rancher.com/docs/rancher/v2.x/en/deploy-across-clusters/fleet/
+) to ensure a streamlined and robust deployment process.
+
+### 📦 Kubernetes example with Rancher & Fleet
+
+### Prerequisites
+
+- A **Rancher-managed Kubernetes cluster** using **RKE2 (RKE Government)**, designed for security and compliance within the Government sector, with FIPS 140-2 compliance and configurations for passing CIS Kubernetes Benchmarks.
+- **Fleet GitOps controller** for automated deployments.
+- **Access to the deployment repository** containing the [OS2-PROJECTNAME] Helm chart.
+
+#### 🛠️ Deployment Steps
 
-### Automatic push deployment with GitOps tools
+1. **Rancher Setup**: Configure your RKE2 Kubernetes cluster with Rancher for an intuitive management experience.
+2. **Fleet Configuration**: Integrate Fleet in Rancher for GitOps deployments, tracking changes to the [OS2-PROJECTNAME] Helm chart.
+3. **Helm Chart**: Ensure the Helm chart is updated in the repository with all configurations.
+4. **Deployment Trigger**: Updates to the Helm chart in the Git repository will prompt Fleet to deploy within the Rancher-managed cluster.
 
+This streamlined process utilizes Kubernetes' orchestration, Rancher's management, and Fleet's continuous deployment for a secure, government-focused deployment pipeline.

From 445726e63c7ed265786a4d4a29ef85543b76a013 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Thu, 13 Jun 2024 20:37:45 +0200
Subject: [PATCH 03/17] Added a rocket for kicks

---
 HOW-TO-DEPLOY.MD | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/HOW-TO-DEPLOY.MD b/HOW-TO-DEPLOY.MD
index 641cf29..4822fd3 100644
--- a/HOW-TO-DEPLOY.MD
+++ b/HOW-TO-DEPLOY.MD
@@ -1,4 +1,4 @@
-# How to Deploy
+# 🚀 How to Deploy
 
 ## Introduction
 

From 500b2e6650eaa88e30428d8fb4f245bbe28e9274 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Wed, 19 Jun 2024 09:44:04 +0200
Subject: [PATCH 04/17] Added GitOps process

---
 HOW-TO-DEPLOY.MD | 74 +++++++++++++++++++++++++-----------------------
 1 file changed, 38 insertions(+), 36 deletions(-)

diff --git a/HOW-TO-DEPLOY.MD b/HOW-TO-DEPLOY.MD
index 4822fd3..5511644 100644
--- a/HOW-TO-DEPLOY.MD
+++ b/HOW-TO-DEPLOY.MD
@@ -5,71 +5,73 @@
 Welcome to the deployment guide for [OS2-PROJECTNAME]. This document will walk you through the process of deploying pre-built containers, whether you're setting up a development environment or deploying to a production cluster.
 
 ## 💻 Development
-To set up a containerized development and test environment on a local computer or in a hosted developer enviroment like GitHub codespaces, you can use the `docker run` or `podman run` to pull the containerimage and run the container.
+To set up a containerized development and test environment on a local computer or in a hosted developer enviroment like GitHub codespaces, you can use a simple `docker run` or `podman run` command to pull the containerimage and run the container.
 
-### Prerequisites
-
-- Docker or Podman installed for local container management.
-- Access to the [OS2-PROJECTNAME] container images.
-
-
-### 🗳️ Docker example
+#### Docker example
 ```shell
 docker run -d -p {CONTAINERPORT:HOSTPORT} --name {CONTAINER_NAME} {IMAGE_NAME}:{TAG}
 ```
 [Official documentation for `docker run`](https://docs.docker.com/reference/cli/docker/container/run/)
 
-### 🐭 Podman example
+#### Podman example
 ```shell
 podman run -d -p {HOSTPORT}:{CONTAINERPORT} --name {CONTAINER_NAME} {IMAGE_NAME}:{TAG}
 ```
 [Official documentation for `podman run`](https://docs.podman.io/en/latest/markdown/podman-run.1.html)
 
 
+
 ## 🚢 Production
+To make deployment of [OS2-PROJECTNAME] simple, fast and standardized, we recommend using the supplied deployment templates in the `https://github.com/{USERNAME}/{REPOSITORY}.git` deployment repository. 
 
-### Deployment on a single host
-For less demanding production environments on a single VM or bare metal host, you can use tools like Ansible, Chef, or Puppet to deploy the container.
+### 🖥 Deployment on a single host
+For less demanding production environments on a single VM or bare metal host, you can use tools like Ansible, Chef, or Puppet to deploy the containerimage.
 
-### Prerequisites
+### Examples
+Below is a couple of examples that can be run either manually or automated with your Configuration Managment tool of choice. The examples expects the correct enviroment variables to exist and acces to the repository ressources.
 
-- Ansible installed for server configuration management.
-- Access to the [OS2-PROJECTNAME] container images in a registry.
-- A user account on the remote host with sufficient privileges to execute Ansible commands.
-- SSH keys for passwordless login between your local machine and the remote host. This involves generating an SSH key pair and adding the public key to the `authorized_keys` file on the remote host.
-- Properly configured environment variables and volumes for production use.
+#### Ansible
 
-### 🅰️ Ansible Example
-Use the following command to run `ansible-pull` from your local machine on the remote host via SSH:
+Example using `ssh` and `ansible-pull` that pulls and runs the default `local.yml` ansible playbook from the `https://github.com/{USERNAME}/{REPOSITORY}.git` repository.
 
 ```shell
-ssh remote_user@remote_host "ansible-pull -U https://github.com/{USERNAME}/{REPOSITORY}.git \\
-             -e 'container_port={CONTAINERPORT}' \ 
-             -e 'host_port={HOSTPORT}' \          
-             -e 'container_name={CONTAINER_NAME}' \ 
-             -e 'image_name={IMAGE_NAME}' \ 
-             -e 'tag={TAG}'"
+ssh remote_user@remote_host "ansible-pull -U https://github.com/{USERNAME}/{REPOSITORY}.git
 ```
+[Official documentation for `ansible-pull`](https://docs.ansible.com/ansible/latest/cli/ansible-pull.html)
+
+#### Chef
+Example using `git` and `chef-apply` to pull and run the `recipe.rb` chef recipes ansible playbook from from the `https://github.com/{USERNAME}/{REPOSITORY}.git` repository.
+
+```shell
+git clone https://github.com/{USERNAME}/{REPOSITORY}.git && \
+
+chef-apply {REPOSITORY}/path/to/recipe.rb
+```
+
 
 ---
 
 ### 🌐 Cluster Deployment
+
 For more demanding production environments that require scalability, fault tolerance, observability and high availability container orchestration tools like [Kubernetes](https://kubernetes.io/), [Nomad](https://www.hashicorp.com/products/nomad), [OpenShift](https://www.openshift.com/) is recommended alongside [GitOps](https://opengitops.dev/) tools like [ArgoCD](https://argoproj.github.io/argo-cd/), [Flux](https://fluxcd.io/) or [Fleet](ttps://rancher.com/docs/rancher/v2.x/en/deploy-across-clusters/fleet/
 ) to ensure a streamlined and robust deployment process.
 
-### 📦 Kubernetes example with Rancher & Fleet
+The deployment templates provided in the `https://github.com/{USERNAME}/{REPOSITORY}.git` deployment repository are designed for integration into a version-controlled [GitOps](https://opengitops.dev/) workflow. These templates are compatible with your chosen [GitOps](https://opengitops.dev/) tools and the container orchestrator of your choice. For more information on GitOps principles and practices, visit the [Open GitOps website](https://opengitops.dev/)
 
-### Prerequisites
+## 🔄 GitOps Process
+Deploy [OS2-PROJECTNAME] to your cluster in 3 steps:
 
-- A **Rancher-managed Kubernetes cluster** using **RKE2 (RKE Government)**, designed for security and compliance within the Government sector, with FIPS 140-2 compliance and configurations for passing CIS Kubernetes Benchmarks.
-- **Fleet GitOps controller** for automated deployments.
-- **Access to the deployment repository** containing the [OS2-PROJECTNAME] Helm chart.
+1. **Initialize and Synchronize**: 
+   - **Clone the Deployment Templates**: Start by cloning the deployment templates from `https://github.com/{USERNAME}/{REPOSITORY}.git`.
+   - **Create a New Branch**: Establish a new branch for your modifications to preserve the integrity of the main branch.
 
-#### 🛠️ Deployment Steps
+2. **Customize and Collaborate**: 
+   - **Customize the Templates**: Tailor the templates to fit your environment and requirements.
+   - **Open a Pull Request (PR)**: Submit a PR for your branch, enabling peer review and collaboration.
 
-1. **Rancher Setup**: Configure your RKE2 Kubernetes cluster with Rancher for an intuitive management experience.
-2. **Fleet Configuration**: Integrate Fleet in Rancher for GitOps deployments, tracking changes to the [OS2-PROJECTNAME] Helm chart.
-3. **Helm Chart**: Ensure the Helm chart is updated in the repository with all configurations.
-4. **Deployment Trigger**: Updates to the Helm chart in the Git repository will prompt Fleet to deploy within the Rancher-managed cluster.
+3. **Merge and Deploy**: 
+   - **Review and Approve**: Have your team review and approve the PR.
+   - **Merge and Trigger**: Merge the approved PR into the main branch, which triggers the GitOps tool to synchronize and apply the configurations to your cluster.
 
-This streamlined process utilizes Kubernetes' orchestration, Rancher's management, and Fleet's continuous deployment for a secure, government-focused deployment pipeline.
+## ☁️ Managed GitOps Hosting
+If preferred, select a managed GitOps hosting provider that aligns with your project's needs and goals.
\ No newline at end of file

From 1cec71b4ca98a89714552c651a90a2c8cf21fe66 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Wed, 19 Jun 2024 10:19:52 +0200
Subject: [PATCH 05/17] Removed chef example

---
 HOW-TO-DEPLOY.MD | 26 ++++++++++----------------
 1 file changed, 10 insertions(+), 16 deletions(-)

diff --git a/HOW-TO-DEPLOY.MD b/HOW-TO-DEPLOY.MD
index 5511644..0f1ef91 100644
--- a/HOW-TO-DEPLOY.MD
+++ b/HOW-TO-DEPLOY.MD
@@ -28,35 +28,29 @@ To make deployment of [OS2-PROJECTNAME] simple, fast and standardized, we recomm
 For less demanding production environments on a single VM or bare metal host, you can use tools like Ansible, Chef, or Puppet to deploy the containerimage.
 
 ### Examples
-Below is a couple of examples that can be run either manually or automated with your Configuration Managment tool of choice. The examples expects the correct enviroment variables to exist and acces to the repository ressources.
+Below is examples that can be run either manually or automated with your Configuration Managment tool of choice. The examples expects the correct enviroment variables to exist and acces to the repository ressources.
 
-#### Ansible
+### Ansible
 
 Example using `ssh` and `ansible-pull` that pulls and runs the default `local.yml` ansible playbook from the `https://github.com/{USERNAME}/{REPOSITORY}.git` repository.
 
 ```shell
 ssh remote_user@remote_host "ansible-pull -U https://github.com/{USERNAME}/{REPOSITORY}.git
 ```
-[Official documentation for `ansible-pull`](https://docs.ansible.com/ansible/latest/cli/ansible-pull.html)
-
-#### Chef
-Example using `git` and `chef-apply` to pull and run the `recipe.rb` chef recipes ansible playbook from from the `https://github.com/{USERNAME}/{REPOSITORY}.git` repository.
-
-```shell
-git clone https://github.com/{USERNAME}/{REPOSITORY}.git && \
-
-chef-apply {REPOSITORY}/path/to/recipe.rb
-```
-
+🔗 [Official documentation for `ansible-pull`](https://docs.ansible.com/ansible/latest/cli/ansible-pull.html)
 
 ---
 
 ### 🌐 Cluster Deployment
 
-For more demanding production environments that require scalability, fault tolerance, observability and high availability container orchestration tools like [Kubernetes](https://kubernetes.io/), [Nomad](https://www.hashicorp.com/products/nomad), [OpenShift](https://www.openshift.com/) is recommended alongside [GitOps](https://opengitops.dev/) tools like [ArgoCD](https://argoproj.github.io/argo-cd/), [Flux](https://fluxcd.io/) or [Fleet](ttps://rancher.com/docs/rancher/v2.x/en/deploy-across-clusters/fleet/
-) to ensure a streamlined and robust deployment process.
+For more demanding production environments that require scalability, fault tolerance, enchanced security, observability and high availability it is best practice to deploy [OS2-PROJECTNAME] to a cluster controlled by a container orchestrator with technologies like like [Kubernetes](https://kubernetes.io/), [Nomad](https://www.hashicorp.com/products/nomad) or [OpenShift](https://www.openshift.com/) together with [GitOps](https://opengitops.dev/) tools like [ArgoCD](https://argoproj.github.io/argo-cd/), [Flux](https://fluxcd.io/) or [Fleet](ttps://rancher.com/docs/rancher/v2.x/en/deploy-across-clusters/fleet/ 
+) 
+
+The deployment templates provided in the `https://github.com/{USERNAME}/{REPOSITORY}.git` deployment repository are designed for integration into a version-controlled [GitOps](https://opengitops.dev/) workflow. These templates are compatible with your chosen [GitOps](https://opengitops.dev/) tools and the container orchestrator of your choice.
+
+🔗 [What is GitOps?](https://about.gitlab.com/topics/gitops/) &ensp; | &ensp;
+🔗 [An illustrated guide to GitOps](https://www.redhat.com/architect/illustrated-guide-gitops)
 
-The deployment templates provided in the `https://github.com/{USERNAME}/{REPOSITORY}.git` deployment repository are designed for integration into a version-controlled [GitOps](https://opengitops.dev/) workflow. These templates are compatible with your chosen [GitOps](https://opengitops.dev/) tools and the container orchestrator of your choice. For more information on GitOps principles and practices, visit the [Open GitOps website](https://opengitops.dev/)
 
 ## 🔄 GitOps Process
 Deploy [OS2-PROJECTNAME] to your cluster in 3 steps:

From 3ec8b79f0dc8b06806c752e310e95f75bccddf97 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Wed, 19 Jun 2024 13:33:36 +0200
Subject: [PATCH 06/17] Moved to docs

---
 HOW-TO-DEPLOY.MD => docs/HOW-TO-DEPLOY.MD | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename HOW-TO-DEPLOY.MD => docs/HOW-TO-DEPLOY.MD (100%)

diff --git a/HOW-TO-DEPLOY.MD b/docs/HOW-TO-DEPLOY.MD
similarity index 100%
rename from HOW-TO-DEPLOY.MD
rename to docs/HOW-TO-DEPLOY.MD

From 4cead352bd3b5660efbd6de3e035df65ebd767a9 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Wed, 19 Jun 2024 13:45:05 +0200
Subject: [PATCH 07/17] Testing Front Matter

---
 docs/HOW-TO-DEPLOY.MD | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/docs/HOW-TO-DEPLOY.MD b/docs/HOW-TO-DEPLOY.MD
index 0f1ef91..6eea52c 100644
--- a/docs/HOW-TO-DEPLOY.MD
+++ b/docs/HOW-TO-DEPLOY.MD
@@ -1,3 +1,8 @@
+---
+layout: default
+title: "🚀 How to Deploy"
+---
+
 # 🚀 How to Deploy
 
 ## Introduction

From 0f663ba409a6c2ac34dede4c5824363ada048d26 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Wed, 19 Jun 2024 14:37:46 +0200
Subject: [PATCH 08/17] Logo, mermaid support  added

---
 _config.yml            |  11 +++++++++--
 assets/images/os2.jpeg | Bin 0 -> 6128 bytes
 2 files changed, 9 insertions(+), 2 deletions(-)
 create mode 100644 assets/images/os2.jpeg

diff --git a/_config.yml b/_config.yml
index faa6eaa..77ab3f4 100644
--- a/_config.yml
+++ b/_config.yml
@@ -1,8 +1,15 @@
-title: Just the Docs Template
-description: A starter template for a Jeykll site using the Just the Docs theme!
+title: OS2 Documentation template
+description: A starter template for an OS2 product documentation build using Jeykll and Just the Docs theme!
 theme: just-the-docs
 
 url: https://just-the-docs.github.io
 
 aux_links:
   Template Repository: https://github.com/just-the-docs/just-the-docs-template
+
+logo: "/assets/images/os2.jpeg"
+
+mermaid:
+  # Version of mermaid library
+  # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
+  version: "10.9.1"
\ No newline at end of file
diff --git a/assets/images/os2.jpeg b/assets/images/os2.jpeg
new file mode 100644
index 0000000000000000000000000000000000000000..31e4466bf3124ada6b292665720d47ad1ad3acfc
GIT binary patch
literal 6128
zcmb7|byQSew8v+L?iq3jX^@lw2apCS0qK@bDJkhjLTMzGknWal0qG8<ySuyI=<oM?
z>;3!oJ?q{R>z?!7>+bux``pK=$0Yz*R!T++00aU6K*RxfoCSyjkU*e61!2gDf`X2M
zf{cuUiH3%Xj*W?pjfIJYg@cO^#=(W)Vqt-a!4LvMA|fJeJQ64|ArzmGi15!OKqSOH
z$S4>nC>Vq|SU80LZ+mP9K+pj_fF2|uEdT@oB0+$UKLJnvNJRo5{So}H0a4M=5h_6#
zh+$ITKlb0)AFn{jNGOjp0Bj^g6^sN%bj?Fvw5YVJ!6J<113(PnFF&VCqUPHPR)(XZ
z%8{}~i<-73;K1lH(aF3{hNz*WsB(m07D(V28Flms)@FhOpySQ14nx<yQOSLX(FQsW
z-GqUyTT?MvMpmjF3H4#3C!w&uS&BI7&-%Bsc@5PEkmPP=S6_5jpL=1dg|*ji0^5P+
zSL=809|6h9-ux|(fX=}hh5IT-qp!Qni??|}w_nyzte&)OFK9grJ$D@+{oc{P*~wLE
zvAz)ASAH;cx!1#;yVmXHRwv$g<el28D;Ftn`*JAifMc^;*V=<u_aK6!)%NgqE_u{#
zrT0!)eKXWdgKc%FeY~tRZN61xPhfg^<J6(s<oHsg1!b{yxOEG+b}hmE1bILN*5+Kw
zvSsVOwP-s(+;g9Ib-MQ8{?I6(e&cK{)RFDbZ7_mo7v>3HJqhb&n;_WSTnM<<O<H<Z
zyFo=I?dl`%UVi6>|A2HpP;UpjId{9|O}*J~j^f2T>=<@v(%0#3>+$yQow=Nt|Jvo9
zR%UZV!EByxV66Sq@Gf9sk#~I2uTrnJOvuAKMTGi>sNghpwRTwK>rxMNeR)9f1~0#v
zzrKj|)|W%S?tr`ULeQ$T`^Zz8T3Fcxbc;VkP4@Rei7SONrl*e*!#FC~R)FbhPzakT
z5!(bE5_-sMtUb9G{!n66WH~YvIXFWoHU>jde)S$M7wXGsLsKZXXb&8lEZvF(5lJjy
z01z1o00M$gQ2vP~6c7?JDgcNErsjr_;3Hz*o|pzEDuxIxbVM`)Q9uvGi?;&jEzkt8
z;@tBo%9raQ7mF92az@ZZrOlGOjEA`!ewv@pa_nq-7VHK;EQ4CpQFR143cPSNTQG;;
z8Gp|}T~0P>|D7;uyqy+TpZ5u}FsFZvuV-g+kc(#XR6c^^U0tGbv$xYDfSdBWE4uhp
z@%vN`7dzgt+I=#IPQguf#$8p9s2}T|OSbf>OkS3Jv}WoygWA-a3c@uIKjz9k3`NGp
z<*)rut20IOLZ%>AT-piBPf`-u^C5c|mc#{Tg=J@VBE%+dKs1+=3_G3gcIl6eX@kQi
zTF_V*QOpY^E2L?F%dxCoDaa}UTQS|D`jeJFnBUPf@sCl7?)*4@e(HH+wQS>dSNL@_
zotQjB5-!)RPFFq9XQ38^7Tne)Lb4xi6G94JeXER>NB5S8uD<#pom07gUG{2;v1?i?
zK{5CIeC*o(SJ}Sd0AzS6m?rHqljC?Mm^-i6+Cbi8cKYsS!BLa<97fAm$Ajr~^vt}r
zYR|bUzX@kT$JN2Ck~_^Oa%iUNrSI7|nSQF>??YB)YrfvBLwV!s9E((Hnb&lEdQyaC
zV4SAH>4h={%ZaANT6L0Y-jstMF~;5=4rjfwablh%dgFryiyT}bI15ERAXTRCyo{B5
zuir}=k`P{5u3`u?nmO*GpZXA%Jk?n68({oh{h~qropeZl%*dAQbne3iQnvWFgm2<o
zgGDlv68yc6?yo}g<I6nd)x+pjGID}qOZEl)ou2UtYzMo<@EDtUY3!)7DPj;&!09sa
z?TuyzW^Sjki`#A`_r?hLdtQY)W@$Rzt<lM6-4S$4F}CSz%qDv#r@S+;!!y-4H#<k$
zus3>_8{OeUWmM0euwl=5V8HdP>tW$rmwQ{S8eJk+dzO?Hxky(lBBtpf01yZSL_+yr
zdICWJBnUnYn3IcI?4^<l0o~tdM$lCRcoWU#K#J*l9>hMwZPRovTeCLkT#5hC?n_Zj
zM?tD*cw)ZO^twn+jd=wmZMpPC2;yQRM=nOV{M{^)ysF^HIgz7D5%L7{+t-2O!jvxq
z5yP@xIS=!iO||U|LDbc+nM$6(&*-e)KXC<r5I8FkmeO5>{(_99>_0m`%Ly{y8o&E#
z-TGW`gMG0e?zxlJVe6bP!UO8R9w5F={|E3O2$++a244v#ru<hu=#Tny0kX14SaZAz
zquY64eWwonmJa=17(F{tANkWbA&gP4*j(<l2xF$$8&-5L6BhR88U3f2()zoIH3Y$b
z-g*!+IyNfelkvxZi1m;m_+T1NF%$w?E@c%X2SRGPm#W6^{Xb_^jMBs4v2DxZCiag1
zvH(>C^ax0z|Ly3YLdvxoM^)le?lb0HIAp0{NgtveWlQzB)S}xHbFHD);rPvDKs<fC
zGrXi2cW1yB(yjKhPL+;>z$qXuIm+VLv1iWaA&6%}(;>XRn#);UdS5CM?*ikj$cWxt
zBkojf7b&-HR!01+^f<ecqL4erGJUC9qeD6M5#X;ir!V)^{GIxc2wA6@vrurbTur=3
ztYZ+H>+u!qjpXmNUuaU;CB+aevdCr9ghh&ByYa)K^rLRFOm{X^D9;`XTO${b?ICzt
z8+KGV<STtYE>Pk6&NTI$`<sS^DQQKAN>bEJ1O?R|!L}y;t73lz2@R-WW`d_Swj*BZ
zTZ*v2U-aH&v`alY9MI=|(o)M=;UN-A9@;#btbxHopM9Mpnt!TZP|B2b>Ij;Y1Q*s;
z83@%&r`u(Ra>j$rki>@tKCOs_n8*>bEZ~x(XOipGgvVMpC8q8~Mm*Pj1jHsox2@bw
zjZgRn23#izQ$A_x#yDYWu^U737n?38d?qZG9s!1FvV4A#Yq$~}b}czIsgC`mKPEJp
z++Qs1j#X1sq$qb8S{*)_7QM2lT(Mud%IUyipjX;)g%#ND8?UT=c3iG=wd8!pIo;*X
zJU(MFEL2=eqHm22Q&yVpwq}8UIZ4LmG0FYiLn+GvmA3svfXx`~5JNehF6Nv}Z8H}e
zWRrHu!bI0iZ$)U5Nr^AkAAaoU5;22p<6!N|d0P`2d4%_re>ticj-?a#e8#pTB~FlX
z8_Sto`Pe>l0peV|TJ7`eCaf&<zL2#iH#IxT&=EF0pS$@BQ&`=abn2uqEh@^Vb+=m@
zL%K0~@r|cWP^Usiv!Xn{(x6>~DU}{Hz(3>Xe7*992$ND&py5jEEOEtAP67t8)~pHh
zU5KI{Q6WY%dGHmPCRqozbcBb@kMC=g_Y`!(E6QlYQpm<kl{&{NRKm~XiN7~#3&{ji
z@!zReO7Y)nu4X7OlxSVQLPWSWctZ*rusUmyzj4j`0B6sRxC%2$Y<6`UJ+fgB?dXe(
ztd;tNgiW8=SKE>VTk2`ld}8v`VohnwrAXzNtYm{U&e;?GhWJH%r<Z$)`Npd{SGAhT
za8lfb^6l*U8m}0Rp?Eng&*o#{hy53^e%tViCW;m7*!(`eg8NYyzAwA<W0hsgG<?}Y
zLh<y&y`c<UIm=8roPGOIjhP9ohwX~LPw{2~q?RWRRkQHzi6}Jozp*+5J2Y)oX+Vid
zA4ER;pSUs)B!rVFL#J#6k{c?}ki<+H&6OJz)Qys8W@F0h8eR1BC*as&ojSNqgO&3#
z?`-OoectBgRK2z6xbD}srRx&mQQxQue|KQ|@e#nT<z^(bq@jIC@4U0>H&WcEG4wn<
zYJ7@`C7ci&a2HE7z{=$@@uqz<^bw%j(A`z8MHlCkopoI{8a1!j?5-X<=W!S{7BFAm
z6m2_Ih0l#1U|bqYkxwsPt)=X#Y0WE8Q$ooaQb$>|<l}t9d0TK<Oa@(k!ol>wBy@M@
ze&(?AMk_;%!n#89;T-~FOkhO53q%4TAoefrfdB|6jhHgnh}z)~w?x~HV57(Xr7t2h
z8mH_VIs^5N>-`9H*XaJOuqU!7^e3Wetsjd7n)CTm4>&%EeObQ?;Ou`Gz9wZ<_3eJn
zb@X+VU}O@weJRV5{{|~#RkS*jS>cHJcvP5tPPb^uwk<Jo?*eTDMZnO8+T84yLd2-u
zub)E+6;5kuL(ALuk(}aITev9kCrzjM95_M1CthkUzB(26MUH6EmRwPrKnYj@i|HkY
zx1yA;-dMljrQgwS4SG~8{I7-G8hMt{vg$9B9swoLGQFp7@AFL~^%J#(t;9F5Jk?A_
zMxyVvMVdQCHIFTmHd8lHQ_sDPbM(qz$oDFQUYxA$o!Q7vOxhI{-Z)Ks{}tC%A2#x0
z<|Xwetxt<_<$(Bk!tNWXp`sbJ9LaL0mMs!+FfXCwAt0Jymul`g#UN#RWqs5w{*fcb
z0APsqqOl$O&4Ig4<@KD9NJSTtWs-&4ngpJb&(J8Z>Ia*cz{EaMU)yGXeSbqQq|y*d
zTkPKipl!XXnMZ&gTO#WBRSlgYnjq&h99z#W<|SEX$9?S2{oEm?+ZpGh^P2O@&Rdq_
z=yQ|04`_E^^<8Q{M8?0TMb%AvdYE^l4BXU@l^oV}Qk`k>KwjDP8GdT9)ackMrMKE<
z){~!9AMaGHvQScD@w+j1%`p_s>_VhYeEO|vOg4;Yg?LwrBUV2(?q<eZ?X{O*Lb7{i
zBaa7E)Ch_I=#Th>*#_?+>6{K*O+&Zv&;1l;$b#Dj1@%<8obov)4ubkC;zUk{UeOr0
z{H*w<a&<?ZT?<o&Vo!#reI?TOm9)3UbK^=|WtZpt*XV3t9DPmxz9_jh<*Wx-w<>Ks
zeC<{&R`c;~`t7!fRlwdAx^=dq=*load<G@ljd<?jo@k_|ISnI*FEGBou_U(7f>+%3
z$6n`1t60YjmA!T0T=P)=fVM1#4d9p8M>l8d@?Ylh5-IG>4sxX4eqYGbomL`Q)FTD%
z9|2VpAwg|h18s$+f%w=>n7eu$&T*%1uRjmV5fcy#2xST2s;t|Jv*1WLGcpyc39XBk
zqLMWn-o2GT)<~Z2O)gVyIXMJ*5S4#9rPC0|YgK()Io^k9c=4@xl9Q{{Cwj~0Q`%ZN
z4<SwzLhMdKX$PgQWJ?O(kKZn&DqbJ+Mo`k!45~MZuIkIyn}lvf(|1s9i&3q~S<)!>
zh<5bjZns@qDPs5WudOxf)~`NL<r7lU(Z9b&eYJUHKpMk$7w}Kx1pD*wb?c64NSSOr
ziz;hXfl7|7nQUBNJoAbwi&}vq{x@pg5X9^JccY8gBLe_nT2(W5w)Zctz6+;$s~dJu
zM(yH_c%PpGac`SbsH86k{E$h6)A9Y&koml7Ly$hbL`mDvZk%81`34mUy~r=Xy|%<L
zxIB!Cd9dLx=k`|1>1aW-FpYkHZtw^Y1<yD1v_+loZuzOdm-8cOoovYmYOXs1gnT}r
zE!-}F@TLUO5E!C`ATWeTIuU!Re+_{lFb#}Tj9S_Mvynr^UjY5dIKgXt3aV`412AvU
z3-fe2XKb~j_UN4>0L}s3i8y270QXs2Ov`<@$9`bGYR-OKj35o0Q@dyv+*2~t8dIYa
z(lE0u5?8%$I@z?Bil*8$fxEjyduJL4BYU8&f@PicGl}jkkVvak-LG|3PXqRa4fk0f
z`L*WD4IjN<#VSsi`Ec34aJ2v2y9@KM_KRl)iXhZeK>qok@E=0|{7(QwXgI0G{Qv6y
zlWT(8VPmjQh?59vk`dI%f0E&LjFxueo?xj3{Sjcvx9Wc0K&eN{NB-lP2*c19=~z7I
z_3TKT6jj(>_zl-9;-%i6t~E|KT`#`wNl;HqSyZ3<gTXw;^(Xy{?TeiTxj7M22_vXw
zwh<)I=<g}0r$Y{*?I{BAKqN#m4*>m_r$PWUoM16!Y9oiw8U7V*u;ruC|K&Rv#PH3!
z=~9Kyv%qnp-b%MB%R{H}Ag5n8rFp#Pw!jfl{&cr&>$dFZR+Sn!oeJ;hw(QnTx?ifS
zBT9DA+^K;x{B0JFvGo&XvIhDyLqwY|D`PbGo}HgvA?#Z?rS(BhRz_C@hg^it&Yxj3
zyUr(AS*l}I;|knfe>+5#i>&N2<>{T4i@L==8f3;lSPP*rkM1~q$&=1q-3WTH_6aeG
zOwFO@8L-e=f=F73A{QBkdc>h~6{EP8F5OIcFH(&)@Z^MQwXoPj`JcUtwk@XMcIlLI
z$@{IeIQ<(}>X?thwV2YHBMB~l*@;zk<aJZ<V6OU|=!1(C24o9%Oq;D9*f}_YC4Xpz
zO2}Z=C^WpP2~=vsFI>tqE=pwoaU%fNBoQv4xl;N52w-{yIQ0{2qE*2oV)kuC(v>b`
z*doQxVw<s6`oqu<)E=Nuy5StNk}fhT6yY;sJfaTRFfgM{^o&bZM&S|lAl9_hqz9*r
zMbZydG>4Ebx4e&p2V8~g`TA8IKTBZ(Z6zTDA3m79p#51NA~&zRAIsu8)m!(gu6(_1
zxN85Sv}5px_(}9VoUm+8Gy2gwF<)fYtZ>{Nv_6A46C?5cpM$82<sv`1yfe0dBz#wR
zd*ma2ZCav~5oEtt06cuUsOQAKEIEF!n<JuTtTeecBpl7&uavvz4-dkxwx$N=xb{@(
z;AYH<yUK%DZ9F_2z}srdFl3p^q?Cp)^Aim5V#&{>9lB)AF?=WqoL&mTdl^~!#K~ti
z?X#@dUcB^$!+#J|p!?2l^R#J)eeHH1Pr}&5=5@$Vnke03Tzkc77HR>bQ4g@FFm+$R
zi9D-+Q{#ypyEqmt9oA2P(ZN3GP2`$XV!_bwdTfC*xr$ESLHY79{dJE<e$aCDSw~3C
z`)pT3=JdQc451E_Zp*B<u@nO$04D~wJ*}57z7Bc8qbcbaZDr@r7>6d@gAGtP;Q%J7
z6Qj{ixSW>cldZStG?;^}Z@etLGGIS+*|%;qM`bGshD0t{47AA8h1h`>00E0l$xy39
z`gUW$-I%YL--^s$lscpgB-T4EyppSSip46%VOfhMgTqQ6A9xgZqt!~&IdvEM-QlU}
z`kt#kir8mVJ1tMuk(u*zr8I8Z^R4ny_D{N8X(LLD9j}lTyArrf#7;E%MajUQ)+-+Y
z9Ea(9S5RC?fe`JYVAd8~iMw08jnwO!c_5j}&-7-D%4armpl)!1X3)@y2&#N_Cclf9
z<TEj(o6$p+>9geq&D9V#^7UUx;qS6c*JHttdAeZc89<jg42ce>y<&$#?fc}YVV!)V
zmgrx4=RfBRCquQK`Umc9wXUgX*<TlhavG>>-AyR|z_`H=JXUBv#@T;Z#<SsNG05ay
zpxku~TYV|PE7_>c%PS@G%;L>~D4KJY4QoX5JyFDT_49&$!oJd-@g;O?tV9-$Hg5b!
z06DSY8Hy~AL@*^MfF=_ky|j$cx;n8^lq>^zP4*2ll?fWFOoP_fwb?-A6Mn(-&1i|V
z9$ya%&3SFXEh4aj_5Qpsm#S<AGLntjWe-n|)`<}x0U>2E?o*WE8S_%f-TflYv<D_K
za-0Fb#fm+x1*WkW1A(W`uTv%GRq3MX7t*GKaAv3cg}2y^9@?b)aFHPw*~JF;GSeTN
zgoGRcb;(O^3`?>e$v`lgA-97ZaaqH6_ladJtFrj`xuObxq&+Q4saU9;-DclNbp{0+
z-!os8%o}1gm!caBg)hBVpsw<Tk%&1<V<bl^xOj)k&;1RB6})$Jz(;@tV6iXKF#CD?
zRJMroshddBtR~?k!mTrUexCeVxuOWN_hXd?&ZehD#U76Uq~>=INPk<U{JJVbk<2ww
zk*TS|JH4CgquI0`8r=3f&A3*~gWkVlhf19+yXCxftrqTC^AHnmhdTMTJ7jjNnkY8J
zXn3m$!m~SMmkaDCjdC2%RS=blIxAiHU~o={%JR7)($3$j-e%z*_cO9Y9M<6M`JKjL
MH9)_h=HvAL01Tlm?*IS*

literal 0
HcmV?d00001


From 183efc09cd5cb50ba56b985ee4c47655b578b093 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Wed, 31 Jul 2024 13:20:10 +0200
Subject: [PATCH 09/17] Work in progress

---
 docs/BASIC_DEVELOPMENT_GUIDE.md |  89 +++++++++++++++++++++++++
 docs/HOW-TO-DEPLOY.MD           | 111 +++++++++++++++++++++++---------
 2 files changed, 168 insertions(+), 32 deletions(-)
 create mode 100644 docs/BASIC_DEVELOPMENT_GUIDE.md

diff --git a/docs/BASIC_DEVELOPMENT_GUIDE.md b/docs/BASIC_DEVELOPMENT_GUIDE.md
new file mode 100644
index 0000000..9c3239f
--- /dev/null
+++ b/docs/BASIC_DEVELOPMENT_GUIDE.md
@@ -0,0 +1,89 @@
+# Getting Started
+Welcome to the basic development guide for [OS2-PROJECTNAME].
+
+This guide will help you set up a controlled, isolated development environment using the projects pre-built containers. 
+By following these steps, you can develop locally or in a managed service like GitHub Codespaces without worrying about conflicts with other software or system libraries.
+
+## Application architecture
+
+```mermaid
+flowchart LR
+
+subgraph Infrastructure
+P
+O
+S
+end
+
+subgraph Application
+BE
+FE
+end
+
+B(Browser)-->P(Reverse Proxy)-->FE(Frontend) & BE(Backend / API)
+FE--> BE -->S[(SQL Database)]
+BE & FE-->|metrics|O{{Observability}}
+
+
+```
+
+## 💻 Development
+
+### Requirements
+To set up a containerized development and test environment on a local computer or in a hosted developer enviroment a container runtime enviroment is needed.
+
+
+
+
+#### Docker example
+
+```shell
+docker run -d -p {CONTAINERPORT:HOSTPORT} --name {CONTAINER_NAME} {IMAGE_NAME}:{TAG}
+```
+
+[Official documentation for `docker run`](https://docs.docker.com/reference/cli/docker/container/run/)
+
+#### Podman example
+
+```shell
+podman run -d -p {HOSTPORT}:{CONTAINERPORT} --name {CONTAINER_NAME} {IMAGE_NAME}:{TAG}
+```
+
+[Official documentation for `podman run`](https://docs.podman.io/en/latest/markdown/podman-run.1.html)
+
+
+Guide: https://docs.docker.com/guides/getting-started/develop-with-containers/
+---
+
+
+## Development
+
+To spin up the project, simply install Docker Desktop and then run the following 
+commands:
+
+```
+git clone https://github.com/docker/getting-started-todo-app
+cd getting-started-todo-app
+docker compose up -d
+```
+
+You'll see several container images get downloaded from Docker Hub and, after a
+moment, the application will be up and running! No need to install or configure
+anything on your machine!
+
+Simply open to [http://localhost](http://localhost) to see the app up and running!
+
+Any changes made to either the backend or frontend should be seen immediately
+without needing to rebuild or restart the containers.
+
+To help with the database, the development stack also includes phpMyAdmin, which
+can be access at [http://db.localhost](http://db.localhost) (most browsers will 
+resolve `*.localhost` correctly, so no hosts file changes should be required).
+
+### Tearing it down
+
+When you're done, simply remove the containers by running the following command:
+
+```
+docker compose down
+```
\ No newline at end of file
diff --git a/docs/HOW-TO-DEPLOY.MD b/docs/HOW-TO-DEPLOY.MD
index 6eea52c..e99a6be 100644
--- a/docs/HOW-TO-DEPLOY.MD
+++ b/docs/HOW-TO-DEPLOY.MD
@@ -5,59 +5,109 @@ title: "🚀 How to Deploy"
 
 # 🚀 How to Deploy
 
-## Introduction
+This document will walk you through the process of deploying pre-built containers to a production host or cluster.
 
-Welcome to the deployment guide for [OS2-PROJECTNAME]. This document will walk you through the process of deploying pre-built containers, whether you're setting up a development environment or deploying to a production cluster.
+To make deployment of [OS2-PROJECTNAME] simple, fast and standardized, we recommend using the supplied deployment templates in the `https://github.com/{USERNAME}/{REPOSITORY}.git` deployment repository. 
 
-## 💻 Development
-To set up a containerized development and test environment on a local computer or in a hosted developer enviroment like GitHub codespaces, you can use a simple `docker run` or `podman run` command to pull the containerimage and run the container.
 
-#### Docker example
-```shell
-docker run -d -p {CONTAINERPORT:HOSTPORT} --name {CONTAINER_NAME} {IMAGE_NAME}:{TAG}
-```
-[Official documentation for `docker run`](https://docs.docker.com/reference/cli/docker/container/run/)
 
-#### Podman example
-```shell
-podman run -d -p {HOSTPORT}:{CONTAINERPORT} --name {CONTAINER_NAME} {IMAGE_NAME}:{TAG}
-```
-[Official documentation for `podman run`](https://docs.podman.io/en/latest/markdown/podman-run.1.html)
+## 🖥 Single Host Deployment
 
+The single host deployment strategy provided by [OS2-PROJECTNAME] operates without redundancy. It lacks the capabilities to auto-scale or auto-heal.
 
+> [!CAUTION] Not Recommended for Production Use
+> ###### This strategy is a cost-effective solution for short-term, limited use systems such as simple Proof of Concepts (PoC) or test systems. While this option allows for a reduction in initial investment, it introduces a single point of failure in the deployment. This deployment strategy is NOT recommended in production systems unless a comprehensive risk assessment process has been conducted and the associated risks have been accepted.
 
-## 🚢 Production
-To make deployment of [OS2-PROJECTNAME] simple, fast and standardized, we recommend using the supplied deployment templates in the `https://github.com/{USERNAME}/{REPOSITORY}.git` deployment repository. 
 
-### 🖥 Deployment on a single host
-For less demanding production environments on a single VM or bare metal host, you can use tools like Ansible, Chef, or Puppet to deploy the containerimage.
+### ⬛ Manual deployment
+The following steps provide a general guide for manual running a container using 
+ a runtime that complies with [the OCI standard for container runtimes](https://opencontainers.org/). While the examples use [podman](https://podman.io), you can replace it with any [OCI](https://opencontainers.org/)-compliant runtime tool that fits your specific needs and system configuration.
+
+1. **Download the Container Image.**
+
+   Use the `pull` command to download the container image from the registry. Add a tag if needed. 
+
+      ```r
+      $ podman pull <image-name>:<tag>
+      ```
+
+2. **Start the Container**
+
+    Use the run command to start the container.
+   
+      ```r
+      $ podman run <image-name>:<tag>.
+      ```
 
-### Examples
-Below is examples that can be run either manually or automated with your Configuration Managment tool of choice. The examples expects the correct enviroment variables to exist and acces to the repository ressources.
+3. **Verify Status**
 
-### Ansible
+   Check if the container is running using the `ps` command.
+      ```r
+      $ podman ps
+      ```
 
-Example using `ssh` and `ansible-pull` that pulls and runs the default `local.yml` ansible playbook from the `https://github.com/{USERNAME}/{REPOSITORY}.git` repository.
+4. **Stop and Remove**
+
+   To stop the container, use `stop` and `rm` to remove it. 
+      ```r
+      $ podman stop <container-id>
+
+      $ podman rm <container-id>
+      ```
+
+   :books: [Official podman documentation](https://podman.io/docs)
+
+### 🅰️ Managed deployment
+You can write deployments to execute the above steps with your preferred deployment tool, whether it is ansible, chef, puppet, salt. The below example uses `ssh` and `ansible-pull` to pull and run the a default `local.yml` ansible playbook from a deployment repository.
+
+```yaml
+- hosts: servers
+  vars:
+    image_name: 'your_image_name_here'
+  tasks:
+    - name: Pull an image
+      containers.podman.podman_image:
+        name: "{{ image_name }}"
+        
+    - name: Run the container
+      containers.podman.podman_container:
+        name: my_container
+        image: "{{ image_name }}"
+        state: started
+      
+    - name: Verify the container is running
+      command: "podman ps -a | grep my_container"
+      register: result
+      
+    - name: Fail if container is not running
+      fail:
+        msg: "Container is not running"
+      when: "'my_container' not in result.stdout"
+
+```
+
+Store the playbook in a dedicated git repository for your deployment and execute it with `ansible-pull`
 
 ```shell
-ssh remote_user@remote_host "ansible-pull -U https://github.com/{USERNAME}/{REPOSITORY}.git
+$ ssh remote_user@remote_host "ansible-pull -U https://github.com/{USERNAME}/{REPOSITORY}.git
 ```
-🔗 [Official documentation for `ansible-pull`](https://docs.ansible.com/ansible/latest/cli/ansible-pull.html)
+   :books: [Official documentation for `ansible-pull`](https://docs.ansible.com/ansible/latest/cli/ansible-pull.html)
 
----
+   :books: [Ansible community documentation - containers.podman](https://docs.ansible.com/ansible/latest/collections/containers/podman/index.html)
 
-### 🌐 Cluster Deployment
 
-For more demanding production environments that require scalability, fault tolerance, enchanced security, observability and high availability it is best practice to deploy [OS2-PROJECTNAME] to a cluster controlled by a container orchestrator with technologies like like [Kubernetes](https://kubernetes.io/), [Nomad](https://www.hashicorp.com/products/nomad) or [OpenShift](https://www.openshift.com/) together with [GitOps](https://opengitops.dev/) tools like [ArgoCD](https://argoproj.github.io/argo-cd/), [Flux](https://fluxcd.io/) or [Fleet](ttps://rancher.com/docs/rancher/v2.x/en/deploy-across-clusters/fleet/ 
+## 🚢 Cluster Deployment
+
+For production environments that require scalability, fault tolerance, enchanced security, observability and high availability it is best practice to deploy [OS2-PROJECTNAME] to a cluster controlled by a container orchestrator with technologies like [Kubernetes](https://kubernetes.io/), [Nomad](https://www.hashicorp.com/products/nomad) or [OpenShift](https://www.openshift.com/) together with [GitOps](https://opengitops.dev/) tools like [ArgoCD](https://argoproj.github.io/argo-cd/), [Flux](https://fluxcd.io/) or [Fleet](ttps://rancher.com/docs/rancher/v2.x/en/deploy-across-clusters/fleet/ 
 ) 
 
-The deployment templates provided in the `https://github.com/{USERNAME}/{REPOSITORY}.git` deployment repository are designed for integration into a version-controlled [GitOps](https://opengitops.dev/) workflow. These templates are compatible with your chosen [GitOps](https://opengitops.dev/) tools and the container orchestrator of your choice.
+The deployment templates provided in the `https://github.com/{USERNAME}/{REPOSITORY}.git` deployment repository are designed for integration into a version-controlled GitOps workflow. These templates are compatible with your chosen GitOps tools and the container orchestrator of your choice.
 
 🔗 [What is GitOps?](https://about.gitlab.com/topics/gitops/) &ensp; | &ensp;
 🔗 [An illustrated guide to GitOps](https://www.redhat.com/architect/illustrated-guide-gitops)
 
 
-## 🔄 GitOps Process
+## 🔄 Recommended deployment process
 Deploy [OS2-PROJECTNAME] to your cluster in 3 steps:
 
 1. **Initialize and Synchronize**: 
@@ -71,6 +121,3 @@ Deploy [OS2-PROJECTNAME] to your cluster in 3 steps:
 3. **Merge and Deploy**: 
    - **Review and Approve**: Have your team review and approve the PR.
    - **Merge and Trigger**: Merge the approved PR into the main branch, which triggers the GitOps tool to synchronize and apply the configurations to your cluster.
-
-## ☁️ Managed GitOps Hosting
-If preferred, select a managed GitOps hosting provider that aligns with your project's needs and goals.
\ No newline at end of file

From 3957bf1c6e744182ca2dc7a0afac246713214253 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Wed, 31 Jul 2024 13:52:08 +0200
Subject: [PATCH 10/17] Note added

---
 docs/HOW-TO-DEPLOY.MD | 36 ++++++++++++++++++++----------------
 1 file changed, 20 insertions(+), 16 deletions(-)

diff --git a/docs/HOW-TO-DEPLOY.MD b/docs/HOW-TO-DEPLOY.MD
index e99a6be..b2afda8 100644
--- a/docs/HOW-TO-DEPLOY.MD
+++ b/docs/HOW-TO-DEPLOY.MD
@@ -5,22 +5,23 @@ title: "🚀 How to Deploy"
 
 # 🚀 How to Deploy
 
-This document will walk you through the process of deploying pre-built containers to a production host or cluster.
-
-To make deployment of [OS2-PROJECTNAME] simple, fast and standardized, we recommend using the supplied deployment templates in the `https://github.com/{USERNAME}/{REPOSITORY}.git` deployment repository. 
+This document will walk you through the process of deploying pre-built containers to a single host or a cluster.
 
+>  [!NOTE] Deployment templates
+> ###### To make deployment of [OS2-PROJECTNAME] simple, fast and standardized, we recommend using the supplied deployment templates in the `https://github.com/{USERNAME}/{REPOSITORY}.git` deployment repository. 
 
+ &ensp;
 
 ## 🖥 Single Host Deployment
 
-The single host deployment strategy provided by [OS2-PROJECTNAME] operates without redundancy. It lacks the capabilities to auto-scale or auto-heal.
+The single host deployment strategy provided by [OS2-PROJECTNAME] operates without redundancy. It lacks the capabilities to auto-scale or auto-heal and it is not suited for more complex multi-container applications.
 
 > [!CAUTION] Not Recommended for Production Use
-> ###### This strategy is a cost-effective solution for short-term, limited use systems such as simple Proof of Concepts (PoC) or test systems. While this option allows for a reduction in initial investment, it introduces a single point of failure in the deployment. This deployment strategy is NOT recommended in production systems unless a comprehensive risk assessment process has been conducted and the associated risks have been accepted.
+> ###### This strategy is a cost-effective solution for short-term, limited use systems such as simple Proof of Concepts (PoC) or test systems. While this option allows for a reduction in initial investment, it introduces a single point of failure in the deployment. This deployment strategy is NOT recommended in production systems unless a comprehensive risk assessment process has been conducted and the associated risks have been documented and accepted.
 
 
 ### ⬛ Manual deployment
-The following steps provide a general guide for manual running a container using 
+The following steps provide a general guide for manual running a single container application using 
  a runtime that complies with [the OCI standard for container runtimes](https://opencontainers.org/). While the examples use [podman](https://podman.io), you can replace it with any [OCI](https://opencontainers.org/)-compliant runtime tool that fits your specific needs and system configuration.
 
 1. **Download the Container Image.**
@@ -60,6 +61,10 @@ The following steps provide a general guide for manual running a container using
 ### 🅰️ Managed deployment
 You can write deployments to execute the above steps with your preferred deployment tool, whether it is ansible, chef, puppet, salt. The below example uses `ssh` and `ansible-pull` to pull and run the a default `local.yml` ansible playbook from a deployment repository.
 
+###### Ansible playbook example:
+
+`local.yml`
+
 ```yaml
 - hosts: servers
   vars:
@@ -83,31 +88,30 @@ You can write deployments to execute the above steps with your preferred deploym
       fail:
         msg: "Container is not running"
       when: "'my_container' not in result.stdout"
-
 ```
 
+</details>
+
 Store the playbook in a dedicated git repository for your deployment and execute it with `ansible-pull`
 
-```shell
+```r
 $ ssh remote_user@remote_host "ansible-pull -U https://github.com/{USERNAME}/{REPOSITORY}.git
 ```
-   :books: [Official documentation for `ansible-pull`](https://docs.ansible.com/ansible/latest/cli/ansible-pull.html)
-
+   :books: [Official documentation for `ansible-pull`](https://docs.ansible.com/ansible/latest/cli/ansible-pull.html) &ensp; | &ensp;
    :books: [Ansible community documentation - containers.podman](https://docs.ansible.com/ansible/latest/collections/containers/podman/index.html)
 
+ &ensp;
 
 ## 🚢 Cluster Deployment
 
 For production environments that require scalability, fault tolerance, enchanced security, observability and high availability it is best practice to deploy [OS2-PROJECTNAME] to a cluster controlled by a container orchestrator with technologies like [Kubernetes](https://kubernetes.io/), [Nomad](https://www.hashicorp.com/products/nomad) or [OpenShift](https://www.openshift.com/) together with [GitOps](https://opengitops.dev/) tools like [ArgoCD](https://argoproj.github.io/argo-cd/), [Flux](https://fluxcd.io/) or [Fleet](ttps://rancher.com/docs/rancher/v2.x/en/deploy-across-clusters/fleet/ 
-) 
-
-The deployment templates provided in the `https://github.com/{USERNAME}/{REPOSITORY}.git` deployment repository are designed for integration into a version-controlled GitOps workflow. These templates are compatible with your chosen GitOps tools and the container orchestrator of your choice.
+)
 
-🔗 [What is GitOps?](https://about.gitlab.com/topics/gitops/) &ensp; | &ensp;
-🔗 [An illustrated guide to GitOps](https://www.redhat.com/architect/illustrated-guide-gitops)
+:books: [What is GitOps?](https://about.gitlab.com/topics/gitops/) &ensp; | &ensp;
+:books: [An illustrated guide to GitOps](https://www.redhat.com/architect/illustrated-guide-gitops)
 
 
-## 🔄 Recommended deployment process
+### ♾️ GitOps deployment process
 Deploy [OS2-PROJECTNAME] to your cluster in 3 steps:
 
 1. **Initialize and Synchronize**: 

From bc026901cb0258422af505adadefb574caa10984 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Wed, 31 Jul 2024 13:58:29 +0200
Subject: [PATCH 11/17] links to cm tools

---
 docs/HOW-TO-DEPLOY.MD | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/docs/HOW-TO-DEPLOY.MD b/docs/HOW-TO-DEPLOY.MD
index b2afda8..fd57374 100644
--- a/docs/HOW-TO-DEPLOY.MD
+++ b/docs/HOW-TO-DEPLOY.MD
@@ -59,7 +59,10 @@ The following steps provide a general guide for manual running a single containe
    :books: [Official podman documentation](https://podman.io/docs)
 
 ### 🅰️ Managed deployment
-You can write deployments to execute the above steps with your preferred deployment tool, whether it is ansible, chef, puppet, salt. The below example uses `ssh` and `ansible-pull` to pull and run the a default `local.yml` ansible playbook from a deployment repository.
+You can write deployments to execute the above steps with your preferred deployment tool, whether it is 
+[Ansible](https://www.ansible.com/), [Chef](https://www.chef.io/), [Puppet](https://puppet.com/) or [Salt](https://saltproject.io/).
+
+The below example uses `ssh` and `ansible-pull` to pull and run a default `local.yml` ansible playbook from a deployment repository.
 
 ###### Ansible playbook example:
 

From 8d43cfe4ad99574b4c8cf4b4d03d6ca968ae421c Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Wed, 31 Jul 2024 14:23:08 +0200
Subject: [PATCH 12/17] dev setup changes

---
 docs/BASIC_DEVELOPMENT_GUIDE.md | 31 +++++--------------------------
 docs/HOW-TO-DEPLOY.MD           | 17 +++++++++++++++++
 2 files changed, 22 insertions(+), 26 deletions(-)

diff --git a/docs/BASIC_DEVELOPMENT_GUIDE.md b/docs/BASIC_DEVELOPMENT_GUIDE.md
index 9c3239f..b134414 100644
--- a/docs/BASIC_DEVELOPMENT_GUIDE.md
+++ b/docs/BASIC_DEVELOPMENT_GUIDE.md
@@ -32,39 +32,18 @@ BE & FE-->|metrics|O{{Observability}}
 ### Requirements
 To set up a containerized development and test environment on a local computer or in a hosted developer enviroment a container runtime enviroment is needed.
 
-
-
-
-#### Docker example
-
-```shell
-docker run -d -p {CONTAINERPORT:HOSTPORT} --name {CONTAINER_NAME} {IMAGE_NAME}:{TAG}
-```
-
-[Official documentation for `docker run`](https://docs.docker.com/reference/cli/docker/container/run/)
-
-#### Podman example
-
-```shell
-podman run -d -p {HOSTPORT}:{CONTAINERPORT} --name {CONTAINER_NAME} {IMAGE_NAME}:{TAG}
-```
-
-[Official documentation for `podman run`](https://docs.podman.io/en/latest/markdown/podman-run.1.html)
-
-
-Guide: https://docs.docker.com/guides/getting-started/develop-with-containers/
 ---
 
 
 ## Development
 
-To spin up the project, simply install Docker Desktop and then run the following 
+To spin up the project, simply install docker-compose and then run the following 
 commands:
 
 ```
-git clone https://github.com/docker/getting-started-todo-app
-cd getting-started-todo-app
-docker compose up -d
+$ git clone https://github.com/docker/getting-started-app
+$ cd getting-started-app
+$ docker compose up -d
 ```
 
 You'll see several container images get downloaded from Docker Hub and, after a
@@ -85,5 +64,5 @@ resolve `*.localhost` correctly, so no hosts file changes should be required).
 When you're done, simply remove the containers by running the following command:
 
 ```
-docker compose down
+$ docker compose down
 ```
\ No newline at end of file
diff --git a/docs/HOW-TO-DEPLOY.MD b/docs/HOW-TO-DEPLOY.MD
index fd57374..53ae61d 100644
--- a/docs/HOW-TO-DEPLOY.MD
+++ b/docs/HOW-TO-DEPLOY.MD
@@ -128,3 +128,20 @@ Deploy [OS2-PROJECTNAME] to your cluster in 3 steps:
 3. **Merge and Deploy**: 
    - **Review and Approve**: Have your team review and approve the PR.
    - **Merge and Trigger**: Merge the approved PR into the main branch, which triggers the GitOps tool to synchronize and apply the configurations to your cluster.
+
+### :gear: Operations
+
+#### Updating the Application
+Explain how to update the application. With GitOps, this is typically done by making a change to the manifests in the Git repository.
+
+#### Rollbacks
+Discuss how to rollback to a previous version of the application. With GitOps, this can be done by reverting the commit in the Git repository.
+
+#### Monitoring and Logging
+Explain how to monitor the health of the application and how to access the logs. Consider integrating with a centralized logging system.
+
+#### Security
+Discuss any security considerations such as network policies, RBAC, and secret management.
+
+#### Troubleshooting
+Provide common troubleshooting steps and known issues.
\ No newline at end of file

From 943ae99296f5d9c82874b6d3fc4b5325cb91a521 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Wed, 14 Aug 2024 10:06:15 +0200
Subject: [PATCH 13/17] Added an Auth node and some styling

---
 docs/BASIC_DEVELOPMENT_GUIDE.md | 34 ++++++++++++++++++---------------
 1 file changed, 19 insertions(+), 15 deletions(-)

diff --git a/docs/BASIC_DEVELOPMENT_GUIDE.md b/docs/BASIC_DEVELOPMENT_GUIDE.md
index b134414..8b1d050 100644
--- a/docs/BASIC_DEVELOPMENT_GUIDE.md
+++ b/docs/BASIC_DEVELOPMENT_GUIDE.md
@@ -8,21 +8,25 @@ By following these steps, you can develop locally or in a managed service like G
 
 ```mermaid
 flowchart LR
-
-subgraph Infrastructure
-P
-O
-S
-end
-
-subgraph Application
-BE
-FE
-end
-
-B(Browser)-->P(Reverse Proxy)-->FE(Frontend) & BE(Backend / API)
-FE--> BE -->S[(SQL Database)]
-BE & FE-->|metrics|O{{Observability}}
+ subgraph Infrastructure["Infrastructure"]
+        P("Reverse Proxy")
+        O{{"🔎  Observability"}}
+        S[("Storage")]
+        A("🛡️ Authentication")
+  end
+ subgraph Application["Application"]
+        BE("Backend / API")
+        FE("Frontend")
+  end
+    B(["👤 Browser"]) --> P
+    P --> FE & BE
+    FE <--> BE & A
+    BE --> S
+    BE -- metrics --> O
+    FE -- metrics --> O
+    style O color:#424242,fill:#FFE0B2
+    style A fill:#BBDEFB,color:#424242
+    style B stroke:#FFFFFF,fill:#C8E6C9,color:#424242
 
 
 ```

From 868ae20c66c92f272478c52929d3eadc870bd694 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Wed, 14 Aug 2024 15:13:27 +0200
Subject: [PATCH 14/17] Styling and text

---
 docs/BASIC_DEVELOPMENT_GUIDE.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/docs/BASIC_DEVELOPMENT_GUIDE.md b/docs/BASIC_DEVELOPMENT_GUIDE.md
index 8b1d050..f26d267 100644
--- a/docs/BASIC_DEVELOPMENT_GUIDE.md
+++ b/docs/BASIC_DEVELOPMENT_GUIDE.md
@@ -9,7 +9,7 @@ By following these steps, you can develop locally or in a managed service like G
 ```mermaid
 flowchart LR
  subgraph Infrastructure["Infrastructure"]
-        P("Reverse Proxy")
+        P[["Reverse Proxy"]]
         O{{"🔎  Observability"}}
         S[("Storage")]
         A("🛡️ Authentication")
@@ -24,11 +24,16 @@ flowchart LR
     BE --> S
     BE -- metrics --> O
     FE -- metrics --> O
+    style P fill:#FFCDD2,color:#424242
     style O color:#424242,fill:#FFE0B2
+    style S fill:#FFF9C4,color:#424242
     style A fill:#BBDEFB,color:#424242
+    style BE fill:#00C853,color:#424242
+    style FE fill:#2962FF,color:#000000
     style B stroke:#FFFFFF,fill:#C8E6C9,color:#424242
 
 
+
 ```
 
 ## 💻 Development

From dc76e38595f13aadcfafd78953b69521ec2f43b0 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Tue, 22 Oct 2024 11:04:02 +0200
Subject: [PATCH 15/17] Added main getting started guide

---
 docs/GETTING_STARTED.md | 40 ++++++++++++++++++++++++++++++++++++++++
 docs/HOW-TO-DEPLOY.MD   |  7 ++++---
 2 files changed, 44 insertions(+), 3 deletions(-)
 create mode 100644 docs/GETTING_STARTED.md

diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md
new file mode 100644
index 0000000..7d4f5b7
--- /dev/null
+++ b/docs/GETTING_STARTED.md
@@ -0,0 +1,40 @@
+# Getting Started with [Your Application Name]
+
+Welcome to the **[Your Application Name]**! This guide will help you get started with our application and provide links to resources tailored for different audiences. Whether you're a Product Owner, Developer, System Administrator, or End-User, we have the information you need to succeed.
+
+## Table of Contents
+1. [Introduction](#introduction)
+2. [Getting Started Guides](#getting-started-guides)
+   - [Product Owners](#product-owners)
+   - [Developers](#developers)
+   - [System Administrators](#system-administrators)
+   - [End-Users](#end-users)
+3. [Additional Resources](#additional-resources)
+4. [Feedback](#feedback)
+
+## Introduction
+[Your Application Name] is designed to [briefly describe the purpose and key features of the application]. This guide aims to provide you with the necessary resources to get started quickly and effectively.
+
+## Getting Started Guides
+
+### Product Owners
+For Product Owners looking to understand the application's capabilities and how it aligns with business goals, visit the following guide:
+- **[Getting Started Guide for Product Owners](link-to-po-guide)**
+
+### Developers
+If you're a Developer wanting to set up your development environment and contribute to the codebase, check out:
+- **[Getting Started Guide for Developers](link-to-developer-guide)**
+
+### System Administrators
+System Administrators can find deployment and maintenance instructions in:
+- **[Getting Started Guide for System Administrators](link-to-admin-guide)**
+
+### End-Users
+End-Users seeking to utilize the application effectively should refer to:
+- **[Getting Started Guide for End-Users](link-to-user-guide)**
+
+## Additional Resources
+Explore more resources related to [Your Application Name]:
+- [Documentation](link-to-docs)
+- [Community Forum](link-to-forum)
+- [FAQs](link-to-faqs)
diff --git a/docs/HOW-TO-DEPLOY.MD b/docs/HOW-TO-DEPLOY.MD
index 53ae61d..3bd5845 100644
--- a/docs/HOW-TO-DEPLOY.MD
+++ b/docs/HOW-TO-DEPLOY.MD
@@ -14,10 +14,11 @@ This document will walk you through the process of deploying pre-built container
 
 ## 🖥 Single Host Deployment
 
-The single host deployment strategy provided by [OS2-PROJECTNAME] operates without redundancy. It lacks the capabilities to auto-scale or auto-heal and it is not suited for more complex multi-container applications.
+*The single host deployment strategy provided by **[OS2-PROJECTNAME]** operates without redundancy and lacks auto-scaling or auto-healing capabilities.*
 
-> [!CAUTION] Not Recommended for Production Use
-> ###### This strategy is a cost-effective solution for short-term, limited use systems such as simple Proof of Concepts (PoC) or test systems. While this option allows for a reduction in initial investment, it introduces a single point of failure in the deployment. This deployment strategy is NOT recommended in production systems unless a comprehensive risk assessment process has been conducted and the associated risks have been documented and accepted.
+> [!CAUTION] Not Recommended for Production Use 
+> ###### This deployment strategy can provide a cost-effective solution for short-term, manually operated, limited-use systems, such as simple Proof of Concepts (PoC) or non-critical applications. However, it presents various risks that could affect system stability and lead to increased operational costs.  
+> ###### Using this strategy for production systems requires the associated risks to be documented and accepted by the steering committee.
 
 
 ### ⬛ Manual deployment

From a4f525986d9674e5210c07384efbf57d69fcc8e6 Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Tue, 22 Oct 2024 11:23:56 +0200
Subject: [PATCH 16/17] Added architecture.md and rename PO + icons

---
 docs/GETTING_STARTED.md | 35 +++++++++++++++++++++++++----------
 1 file changed, 25 insertions(+), 10 deletions(-)

diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md
index 7d4f5b7..314d245 100644
--- a/docs/GETTING_STARTED.md
+++ b/docs/GETTING_STARTED.md
@@ -4,37 +4,52 @@ Welcome to the **[Your Application Name]**! This guide will help you get started
 
 ## Table of Contents
 1. [Introduction](#introduction)
-2. [Getting Started Guides](#getting-started-guides)
+2. [System Architecture](#system-architecture)
+3. [Getting Started Guides](#getting-started-guides)
    - [Product Owners](#product-owners)
    - [Developers](#developers)
    - [System Administrators](#system-administrators)
    - [End-Users](#end-users)
-3. [Additional Resources](#additional-resources)
-4. [Feedback](#feedback)
+4. [Additional Resources](#additional-resources)
+5. [Feedback](#feedback)
 
 ## Introduction
 [Your Application Name] is designed to [briefly describe the purpose and key features of the application]. This guide aims to provide you with the necessary resources to get started quickly and effectively.
 
+## Architecture overview
+For an overview of the system architecture, including components, relationships, and design decisions, please refer to our dedicated architecture document:
+
+🗺️ **[Architecture Overview](link-to-architecture.md)**
+
+This document provides essential insights into how the application is structured and how its various parts interact.
+
 ## Getting Started Guides
 
-### Product Owners
-For Product Owners looking to understand the application's capabilities and how it aligns with business goals, visit the following guide:
-- **[Getting Started Guide for Product Owners](link-to-po-guide)**
+### Business Stakeholders
+For Business Stakeholders looking to understand the application's capabilities and how it aligns with business goals, visit the following guide:
+
+🏛️ **[Getting Started Guide for Business Stakeholders](link-to-business-stakeholders-guide)**
 
 ### Developers
 If you're a Developer wanting to set up your development environment and contribute to the codebase, check out:
-- **[Getting Started Guide for Developers](link-to-developer-guide)**
+
+💻 **[Getting Started Guide for Developers](link-to-developer-guide)**
 
 ### System Administrators
 System Administrators can find deployment and maintenance instructions in:
-- **[Getting Started Guide for System Administrators](link-to-admin-guide)**
+
+🧑‍🔧 **[Getting Started Guide for System Administrators](link-to-admin-guide)**
 
 ### End-Users
 End-Users seeking to utilize the application effectively should refer to:
-- **[Getting Started Guide for End-Users](link-to-user-guide)**
+
+👥 **[Getting Started Guide for End-Users](link-to-user-guide)**
 
 ## Additional Resources
 Explore more resources related to [Your Application Name]:
-- [Documentation](link-to-docs)
+- [Issue Tracker](link-to-issue-tracker)
 - [Community Forum](link-to-forum)
 - [FAQs](link-to-faqs)
+
+## Feedback
+We value your input! If you have suggestions or feedback on this guide or any of the linked resources, please let us know through our feedback form: [Feedback Form Link].

From 33ed981df3294c7f4d5489a139d2918069fb797e Mon Sep 17 00:00:00 2001
From: Jan Maack Kjerbye <50995332+janhalen@users.noreply.github.com>
Date: Tue, 22 Oct 2024 11:24:37 +0200
Subject: [PATCH 17/17] Removed specific guides

---
 docs/BASIC_DEVELOPMENT_GUIDE.md |  77 -----------------
 docs/HOW-TO-DEPLOY.MD           | 148 --------------------------------
 2 files changed, 225 deletions(-)
 delete mode 100644 docs/BASIC_DEVELOPMENT_GUIDE.md
 delete mode 100644 docs/HOW-TO-DEPLOY.MD

diff --git a/docs/BASIC_DEVELOPMENT_GUIDE.md b/docs/BASIC_DEVELOPMENT_GUIDE.md
deleted file mode 100644
index f26d267..0000000
--- a/docs/BASIC_DEVELOPMENT_GUIDE.md
+++ /dev/null
@@ -1,77 +0,0 @@
-# Getting Started
-Welcome to the basic development guide for [OS2-PROJECTNAME].
-
-This guide will help you set up a controlled, isolated development environment using the projects pre-built containers. 
-By following these steps, you can develop locally or in a managed service like GitHub Codespaces without worrying about conflicts with other software or system libraries.
-
-## Application architecture
-
-```mermaid
-flowchart LR
- subgraph Infrastructure["Infrastructure"]
-        P[["Reverse Proxy"]]
-        O{{"🔎  Observability"}}
-        S[("Storage")]
-        A("🛡️ Authentication")
-  end
- subgraph Application["Application"]
-        BE("Backend / API")
-        FE("Frontend")
-  end
-    B(["👤 Browser"]) --> P
-    P --> FE & BE
-    FE <--> BE & A
-    BE --> S
-    BE -- metrics --> O
-    FE -- metrics --> O
-    style P fill:#FFCDD2,color:#424242
-    style O color:#424242,fill:#FFE0B2
-    style S fill:#FFF9C4,color:#424242
-    style A fill:#BBDEFB,color:#424242
-    style BE fill:#00C853,color:#424242
-    style FE fill:#2962FF,color:#000000
-    style B stroke:#FFFFFF,fill:#C8E6C9,color:#424242
-
-
-
-```
-
-## 💻 Development
-
-### Requirements
-To set up a containerized development and test environment on a local computer or in a hosted developer enviroment a container runtime enviroment is needed.
-
----
-
-
-## Development
-
-To spin up the project, simply install docker-compose and then run the following 
-commands:
-
-```
-$ git clone https://github.com/docker/getting-started-app
-$ cd getting-started-app
-$ docker compose up -d
-```
-
-You'll see several container images get downloaded from Docker Hub and, after a
-moment, the application will be up and running! No need to install or configure
-anything on your machine!
-
-Simply open to [http://localhost](http://localhost) to see the app up and running!
-
-Any changes made to either the backend or frontend should be seen immediately
-without needing to rebuild or restart the containers.
-
-To help with the database, the development stack also includes phpMyAdmin, which
-can be access at [http://db.localhost](http://db.localhost) (most browsers will 
-resolve `*.localhost` correctly, so no hosts file changes should be required).
-
-### Tearing it down
-
-When you're done, simply remove the containers by running the following command:
-
-```
-$ docker compose down
-```
\ No newline at end of file
diff --git a/docs/HOW-TO-DEPLOY.MD b/docs/HOW-TO-DEPLOY.MD
deleted file mode 100644
index 3bd5845..0000000
--- a/docs/HOW-TO-DEPLOY.MD
+++ /dev/null
@@ -1,148 +0,0 @@
----
-layout: default
-title: "🚀 How to Deploy"
----
-
-# 🚀 How to Deploy
-
-This document will walk you through the process of deploying pre-built containers to a single host or a cluster.
-
->  [!NOTE] Deployment templates
-> ###### To make deployment of [OS2-PROJECTNAME] simple, fast and standardized, we recommend using the supplied deployment templates in the `https://github.com/{USERNAME}/{REPOSITORY}.git` deployment repository. 
-
- &ensp;
-
-## 🖥 Single Host Deployment
-
-*The single host deployment strategy provided by **[OS2-PROJECTNAME]** operates without redundancy and lacks auto-scaling or auto-healing capabilities.*
-
-> [!CAUTION] Not Recommended for Production Use 
-> ###### This deployment strategy can provide a cost-effective solution for short-term, manually operated, limited-use systems, such as simple Proof of Concepts (PoC) or non-critical applications. However, it presents various risks that could affect system stability and lead to increased operational costs.  
-> ###### Using this strategy for production systems requires the associated risks to be documented and accepted by the steering committee.
-
-
-### ⬛ Manual deployment
-The following steps provide a general guide for manual running a single container application using 
- a runtime that complies with [the OCI standard for container runtimes](https://opencontainers.org/). While the examples use [podman](https://podman.io), you can replace it with any [OCI](https://opencontainers.org/)-compliant runtime tool that fits your specific needs and system configuration.
-
-1. **Download the Container Image.**
-
-   Use the `pull` command to download the container image from the registry. Add a tag if needed. 
-
-      ```r
-      $ podman pull <image-name>:<tag>
-      ```
-
-2. **Start the Container**
-
-    Use the run command to start the container.
-   
-      ```r
-      $ podman run <image-name>:<tag>.
-      ```
-
-3. **Verify Status**
-
-   Check if the container is running using the `ps` command.
-      ```r
-      $ podman ps
-      ```
-
-4. **Stop and Remove**
-
-   To stop the container, use `stop` and `rm` to remove it. 
-      ```r
-      $ podman stop <container-id>
-
-      $ podman rm <container-id>
-      ```
-
-   :books: [Official podman documentation](https://podman.io/docs)
-
-### 🅰️ Managed deployment
-You can write deployments to execute the above steps with your preferred deployment tool, whether it is 
-[Ansible](https://www.ansible.com/), [Chef](https://www.chef.io/), [Puppet](https://puppet.com/) or [Salt](https://saltproject.io/).
-
-The below example uses `ssh` and `ansible-pull` to pull and run a default `local.yml` ansible playbook from a deployment repository.
-
-###### Ansible playbook example:
-
-`local.yml`
-
-```yaml
-- hosts: servers
-  vars:
-    image_name: 'your_image_name_here'
-  tasks:
-    - name: Pull an image
-      containers.podman.podman_image:
-        name: "{{ image_name }}"
-        
-    - name: Run the container
-      containers.podman.podman_container:
-        name: my_container
-        image: "{{ image_name }}"
-        state: started
-      
-    - name: Verify the container is running
-      command: "podman ps -a | grep my_container"
-      register: result
-      
-    - name: Fail if container is not running
-      fail:
-        msg: "Container is not running"
-      when: "'my_container' not in result.stdout"
-```
-
-</details>
-
-Store the playbook in a dedicated git repository for your deployment and execute it with `ansible-pull`
-
-```r
-$ ssh remote_user@remote_host "ansible-pull -U https://github.com/{USERNAME}/{REPOSITORY}.git
-```
-   :books: [Official documentation for `ansible-pull`](https://docs.ansible.com/ansible/latest/cli/ansible-pull.html) &ensp; | &ensp;
-   :books: [Ansible community documentation - containers.podman](https://docs.ansible.com/ansible/latest/collections/containers/podman/index.html)
-
- &ensp;
-
-## 🚢 Cluster Deployment
-
-For production environments that require scalability, fault tolerance, enchanced security, observability and high availability it is best practice to deploy [OS2-PROJECTNAME] to a cluster controlled by a container orchestrator with technologies like [Kubernetes](https://kubernetes.io/), [Nomad](https://www.hashicorp.com/products/nomad) or [OpenShift](https://www.openshift.com/) together with [GitOps](https://opengitops.dev/) tools like [ArgoCD](https://argoproj.github.io/argo-cd/), [Flux](https://fluxcd.io/) or [Fleet](ttps://rancher.com/docs/rancher/v2.x/en/deploy-across-clusters/fleet/ 
-)
-
-:books: [What is GitOps?](https://about.gitlab.com/topics/gitops/) &ensp; | &ensp;
-:books: [An illustrated guide to GitOps](https://www.redhat.com/architect/illustrated-guide-gitops)
-
-
-### ♾️ GitOps deployment process
-Deploy [OS2-PROJECTNAME] to your cluster in 3 steps:
-
-1. **Initialize and Synchronize**: 
-   - **Clone the Deployment Templates**: Start by cloning the deployment templates from `https://github.com/{USERNAME}/{REPOSITORY}.git`.
-   - **Create a New Branch**: Establish a new branch for your modifications to preserve the integrity of the main branch.
-
-2. **Customize and Collaborate**: 
-   - **Customize the Templates**: Tailor the templates to fit your environment and requirements.
-   - **Open a Pull Request (PR)**: Submit a PR for your branch, enabling peer review and collaboration.
-
-3. **Merge and Deploy**: 
-   - **Review and Approve**: Have your team review and approve the PR.
-   - **Merge and Trigger**: Merge the approved PR into the main branch, which triggers the GitOps tool to synchronize and apply the configurations to your cluster.
-
-### :gear: Operations
-
-#### Updating the Application
-Explain how to update the application. With GitOps, this is typically done by making a change to the manifests in the Git repository.
-
-#### Rollbacks
-Discuss how to rollback to a previous version of the application. With GitOps, this can be done by reverting the commit in the Git repository.
-
-#### Monitoring and Logging
-Explain how to monitor the health of the application and how to access the logs. Consider integrating with a centralized logging system.
-
-#### Security
-Discuss any security considerations such as network policies, RBAC, and secret management.
-
-#### Troubleshooting
-Provide common troubleshooting steps and known issues.
\ No newline at end of file