docs: Create documentation for the deployment examples

Author: alhendrickson

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "files.exclude": {
+        "**/.terraform/": true,
+        "**/.terraform.lock.hcl": true,
+        "**/terraform.tfstate": true,
+        "**/terraform.tfstate.backup": true,
+        "**/terraform.tfstate.*.backup": true,
+        "**/.ansible/": true
+    }
+}

README.md

@@ -1,5 +1,10 @@
-# Cogstack Platform Toolkit
+# Cogstack Platform
 
 This repository contains tools and services used to support CogStack deployments
 
-See the latest documentation on [Readthedocs](https://cogstack-platform-toolkit.readthedocs.io/en/latest/observability/_index.html)
+See the latest documentation on [Readthedocs](https://docs.cogstack.org/en/latest/)
+
+## Project contents
+- Source for the official cogstack documentation. This git repo stores the top level documetation that hosts on https://docs.cogstack.org
+- CogStack deployment instructions and examples
+- CogStack platform tools eg Observability. 

deployment/terraform/examples/aws-kubernetes/README.md

@@ -1,4 +1,4 @@
-# AWS Deployment
+# AWS EKS Deployment
 
 This is an example deployment of CogStack in AWS. It will create publically accessible services, so is not suitable for production deployment.
 

deployment/terraform/examples/azure-kubernetes/README.md

@@ -1,4 +1,4 @@
-# Azure AKS deployment
+# Azure AKS Deployment
 
 This is an example deployment of CogStack in Azure. 
 

deployment/terraform/examples/openstack-docker/README.md

@@ -1,4 +1,4 @@
-# Openstack Docker Example Module
+# Openstack Docker Deployment
 
 This Terraform example provides one stop approach to deploy the **CogStack** platform with its core components and observability stack in an OpenStack environment. It is specifically designed to simplify and automate the provisioning and configuration needed to run CogStack reliably and securely. 
 

deployment/terraform/examples/openstack-kubernetes/README.md

@@ -1,4 +1,4 @@
-# Openstack Kubernetes Example Module
+# Openstack Kubernetes Deployment
 
 This Terraform example provides one stop approach to deploy the **CogStack** platform with its core components and observability stack in an OpenStack environment. It is specifically designed to simplify and automate the provisioning and configuration needed to run CogStack reliably and securely. 
 

deployment/terraform/modules/cogstack-helm-services/README.md

@@ -1,2 +1,28 @@
 
-Terraform module for running cogstack services through Helm
+# CogStack Helm Terraform Module
+This Terraform module deploys CogStack services using Helm charts on a Kubernetes cluster.
+
+## Example usage
+
+```hcl
+module "cogstack_helm_services" {
+  source = "path_to_module"
+  medcat_service_values = <<EOT
+replicaCount: 2
+EOT
+
+}
+```
+
+## What is this module for?
+This module simplifies deploying the CogStack with an opinionated Helm release setup. 
+
+It does the following:
+- Deploys MedCAT Service using Helm
+- Configures Ingress based on path prefix and hostname
+- Runs a terraform Check as an integration test on the deployed service
+
+The module expects Kubernetes and Helm providers to be configured and a working cluster available.
+
+
+

docs/index.md

@@ -37,7 +37,7 @@ MedCAT Trainer <https://docs.cogstack.org/projects/medcat-trainer/>
 :caption: CogStack Platform
 
 NiFi <https://docs.cogstack.org/projects/nifi/>
-
+platform/deployment/_index.md
 platform/_index
 ```
 

docs/overview/CogStack ecosystem (v1).md

@@ -35,7 +35,7 @@ Usually, the sink will be the ElasticSearch store, keeping the processed EHRs wh
 
 The information about available data processing components offered by CogStack Pipeline can be found in [CogStack Pipeline](CogStack%20Pipeline.md) part.
 
-:::{ifno}
+:::{info}
 We recommend using CogStack Pipeline component in the newest version 1.3.0.
 :::
 

docs/platform/deployment/_index.md

@@ -0,0 +1,42 @@
+# Deployment
+
+## Introduction
+:::{warning}
+We are actively working on improving the deployment of CogStack
+
+The following section shows how to run MedCAT Service in a variety of environments and configs.
+
+To setup a full deployment of CogStack including the data pipelines and infrastructure, contact us
+:::
+
+## Overview
+CogStack is a self-hosted platform made up of microservices and tools
+
+If you want to get started quickly, check out the [Quickstart](./get-started/quickstart) guide to run CogStack locally in just a few simple steps.
+
+Our recommended deployment method is on Kubernetes using Helm charts. This makes installing and managing CogStack easy and consistent. For a detailed walkthrough, see [Helm](./helm/_index) .
+
+You can run Kubernetes anywhere — on your own hardware or through cloud providers like AWS (EKS) or Azure (AKS). To help with this, we provide basic examples that deploy infrastructure, CogStack, and tests using Terraform. These are available in the [Examples](./examples/_index) folder.
+
+Along with kubernetes, it is also possible to run CogStack through docker compose. See the [Reference](./reference/_index) folder for this. 
+
+
+## Recommendations
+
+- Deploy CogStack on Kubernetes for best scalability and reliability.
+- Use Helm to install and manage your CogStack instances.
+- Manage your infrastructure declaratively with Terraform.
+- Keep your Terraform code in a Git repository and adopt GitOps workflows so all infrastructure changes go through version control
+
+
+```{toctree}
+:maxdepth: 2
+
+get-started/_index
+
+helm/_index
+
+examples/_index
+
+reference/_index
+```