Update docs

.terraform-docs.yml

@@ -3,14 +3,12 @@ formatter: "markdown table"
 content: |-
   {{ .Header }}
 
-  ## Overview
-
   # Relativistic
 
   Relativistic is a Terraform, Helm, and custom configuration project to be able to deploy an production grade open source data stack quickly.
 
   For full documentation, visit [docs.relativistic.io](https://docs.relativistic.io).
-  
+
   {{ .Inputs }}
 
   {{ .Outputs }}

README.md

@@ -1,8 +1,4 @@
-# Readme Module
-
-
-
-### Overview
+# Relativistic 
 
 # Relativistic
 
@@ -108,7 +104,7 @@ No resources.
 | <a name="module_dagster"></a> [dagster](#module\_dagster) | ./modules/dagster | n/a |
 | <a name="module_kubernetes_dashboard"></a> [kubernetes\_dashboard](#module\_kubernetes\_dashboard) | ./modules/kubernetes-dashboard | n/a |
 | <a name="module_lightdash"></a> [lightdash](#module\_lightdash) | ./modules/lightdash | n/a |
-| <a name="module_prometheus"></a> [prometheus](#module\_prometheus) | ./modules/prometheus | n/a |
+| <a name="module_prometheus"></a> [prometheus](#module\_prometheus) | ./modules/monitoring | n/a |
 | <a name="module_superset"></a> [superset](#module\_superset) | ./modules/superset | n/a |
 | <a name="module_ubuntu"></a> [ubuntu](#module\_ubuntu) | ./modules/ubuntu | n/a |
 | <a name="module_windmill"></a> [windmill](#module\_windmill) | ./modules/windmill | n/a |

main.tf

@@ -99,7 +99,7 @@ module "kubernetes_dashboard" {
 
 module "prometheus" {
     count  = var.prometheus_enabled ? 1 : 0
-    source = "./modules/prometheus"
+    source = "./modules/monitoring"
     prometheus_operator_chart_version = var.prometheus_operator_chart_version
     loki_chart_version = var.loki_chart_version
     prometheus_override_helm_values = var.prometheus_override_helm_values

modules/airbyte/README.md

@@ -1,6 +1,4 @@
-# Readme Module
-
-
+# Airbyte 
 
 ### Overview
 

modules/airflow/README.md

@@ -1,6 +1,4 @@
-# Readme Module
-
-
+# Airflow 
 
 ### Overview
 

modules/analytics_postgres/README.md

@@ -1,6 +1,4 @@
-# Readme Module
-
-
+# Analytics postgres 
 
 ### Overview
 

modules/argo_cd/README.md

@@ -1,6 +1,4 @@
-# Readme Module
-
-
+# Argo cd 
 
 ### Overview
 

modules/argo_workflows/README.md

@@ -1,6 +1,4 @@
-# Readme Module
-
-
+# Argo workflows 
 
 ### Overview
 

modules/clickhouse/README.md

@@ -1,6 +1,4 @@
-# Readme Module
-
-
+# Clickhouse 
 
 ### Overview
 

modules/configuration_postgres/README.md

@@ -1,6 +1,4 @@
-# Readme Module
-
-
+# Configuration postgres 
 
 ### Overview
 

modules/dagster/README.md

@@ -1,6 +1,4 @@
-# Readme Module
-
-
+# Dagster 
 
 ### Overview
 

modules/kubernetes-dashboard/README.md

@@ -1,6 +1,4 @@
-# Readme Module
-
-
+# Kubernetes dashboard 
 
 ### Overview
 

modules/lightdash/README.md

@@ -1,6 +1,4 @@
-# Readme Module
-
-
+# Lightdash 
 
 ### Overview
 

modules/prometheus/README.md → modules/monitoring/README.md

@@ -1,6 +1,4 @@
-# Readme Module
-
-
+# Monitoring 
 
 ### Overview
 

modules/superset/.terraform-docs.yml

@@ -9,7 +9,10 @@ content: |-
 
   ## Example Usage
   From [examples/simple/main.tf](https://github.com/kadreio/relativistic/blob/main/modules/superset/examples/simple/main.tf)
+
+  ```hcl
   {{ include "examples/simple/main.tf" }}
+  ```
 
   {{ .Inputs }}
 

modules/superset/README.md

@@ -1,13 +1,13 @@
-# Readme Module
-
-
+# Superset 
 
 ### Overview
 
 This module deploys Apache Superset, a modern data exploration and visualization platform, on Kubernetes. It sets up the Superset web application, its dependencies, and the necessary database using a Helm chart. The module also configures authentication and exposes the Superset UI for easy access to data analytics and dashboard creation.
 
 ### Example Usage
 From [examples/simple/main.tf](https://github.com/kadreio/relativistic/blob/main/modules/superset/examples/simple/main.tf)
+
+```hcl
 provider "kubernetes" {
     config_path = "~/.kube/config"
 }
@@ -27,6 +27,7 @@ resource "random_string" "cookie_key" {
     length  = 32
     special = false
 }
+```
 
 ### Inputs
 

modules/ubuntu/README.md

@@ -1,6 +1,4 @@
-# Readme Module
-
-
+# Ubuntu 
 
 ### Overview
 

modules/windmill/README.md

@@ -1,6 +1,4 @@
-# Readme Module
-
-
+# Windmill 
 
 ### Overview
 

sp/docs/source/generate_tf_docs.py

@@ -2,11 +2,11 @@
 import subprocess
 
 
-def process_markdown(content, filename):
+def process_markdown(content, filename, title):
     # Add title header
-    title = os.path.splitext(os.path.basename(filename))[0].replace('_', ' ').replace('-', ' ').capitalize()
+    # title = os.path.splitext(os.path.basename(filename))[0].replace('_', ' ').replace('-', ' ').capitalize()
 
-    content = f"# {title} Module\n\n{content}"
+    content = f"# {title} {content}"
 
     # Replace "##" headers with "###" headers
     lines = content.split('\n')
@@ -23,6 +23,9 @@ def process_markdown(content, filename):
 
 def generate_module_doc(module_path, output_file):
     try:
+
+        title = os.path.splitext(os.path.basename(output_file))[0].replace('_', ' ').replace('-', ' ').capitalize()
+
         result = subprocess.run(
             ['terraform-docs', 'markdown', 'table', '--config', os.path.join(module_path, '.terraform-docs.yml'), module_path],
             capture_output=True,
@@ -32,12 +35,12 @@ def generate_module_doc(module_path, output_file):
 
         # Write the output to the file
         with open(output_file, 'w') as f:
-            f.write(process_markdown(result.stdout, output_file))
+            f.write(process_markdown(result.stdout, output_file, title))
 
         # Write the output to the README.md in the module directory
         readme_path = os.path.join(module_path, 'README.md')
         with open(readme_path, 'w') as readme:
-            readme.write(process_markdown(result.stdout, readme_path))
+            readme.write(process_markdown(result.stdout, readme_path, title))
 
         print(f"Generated README.md for {os.path.basename(module_path)}")
 

sp/docs/source/terraform/relativistic.md

@@ -1,8 +1,4 @@
-# Relativistic Module
-
-
-
-### Overview
+# Relativistic 
 
 # Relativistic
 
@@ -108,7 +104,7 @@ No resources.
 | <a name="module_dagster"></a> [dagster](#module\_dagster) | ./modules/dagster | n/a |
 | <a name="module_kubernetes_dashboard"></a> [kubernetes\_dashboard](#module\_kubernetes\_dashboard) | ./modules/kubernetes-dashboard | n/a |
 | <a name="module_lightdash"></a> [lightdash](#module\_lightdash) | ./modules/lightdash | n/a |
-| <a name="module_prometheus"></a> [prometheus](#module\_prometheus) | ./modules/prometheus | n/a |
+| <a name="module_prometheus"></a> [prometheus](#module\_prometheus) | ./modules/monitoring | n/a |
 | <a name="module_superset"></a> [superset](#module\_superset) | ./modules/superset | n/a |
 | <a name="module_ubuntu"></a> [ubuntu](#module\_ubuntu) | ./modules/ubuntu | n/a |
 | <a name="module_windmill"></a> [windmill](#module\_windmill) | ./modules/windmill | n/a |

sp/docs/source/terraform/submodule/airbyte.md

@@ -1,6 +1,4 @@
-# Airbyte Module
-
-
+# Airbyte 
 
 ### Overview
 

sp/docs/source/terraform/submodule/airflow.md

@@ -1,6 +1,4 @@
-# Airflow Module
-
-
+# Airflow 
 
 ### Overview
 

sp/docs/source/terraform/submodule/analytics_postgres.md

@@ -1,6 +1,4 @@
-# Analytics postgres Module
-
-
+# Analytics postgres 
 
 ### Overview
 

sp/docs/source/terraform/submodule/argo_cd.md

@@ -1,6 +1,4 @@
-# Argo cd Module
-
-
+# Argo cd 
 
 ### Overview
 

sp/docs/source/terraform/submodule/argo_workflows.md

@@ -1,6 +1,4 @@
-# Argo workflows Module
-
-
+# Argo workflows 
 
 ### Overview
 

sp/docs/source/terraform/submodule/clickhouse.md

@@ -1,6 +1,4 @@
-# Clickhouse Module
-
-
+# Clickhouse 
 
 ### Overview
 

sp/docs/source/terraform/submodule/configuration_postgres.md

@@ -1,6 +1,4 @@
-# Configuration postgres Module
-
-
+# Configuration postgres 
 
 ### Overview
 

sp/docs/source/terraform/submodule/dagster.md

@@ -1,6 +1,4 @@
-# Dagster Module
-
-
+# Dagster 
 
 ### Overview
 

sp/docs/source/terraform/submodule/kubernetes-dashboard.md

@@ -1,6 +1,4 @@
-# Kubernetes dashboard Module
-
-
+# Kubernetes dashboard 
 
 ### Overview
 

sp/docs/source/terraform/submodule/lightdash.md

@@ -1,6 +1,4 @@
-# Lightdash Module
-
-
+# Lightdash 
 
 ### Overview
 

sp/docs/source/terraform/submodule/prometheus.md → sp/docs/source/terraform/submodule/monitoring.md

@@ -1,6 +1,4 @@
-# Prometheus Module
-
-
+# Monitoring 
 
 ### Overview
 

sp/docs/source/terraform/submodule/superset.md

@@ -1,13 +1,13 @@
-# Superset Module
-
-
+# Superset 
 
 ### Overview
 
 This module deploys Apache Superset, a modern data exploration and visualization platform, on Kubernetes. It sets up the Superset web application, its dependencies, and the necessary database using a Helm chart. The module also configures authentication and exposes the Superset UI for easy access to data analytics and dashboard creation.
 
 ### Example Usage
 From [examples/simple/main.tf](https://github.com/kadreio/relativistic/blob/main/modules/superset/examples/simple/main.tf)
+
+```hcl
 provider "kubernetes" {
     config_path = "~/.kube/config"
 }
@@ -27,6 +27,7 @@ resource "random_string" "cookie_key" {
     length  = 32
     special = false
 }
+```
 
 ### Inputs
 

sp/docs/source/terraform/submodule/ubuntu.md

@@ -1,6 +1,4 @@
-# Ubuntu Module
-
-
+# Ubuntu 
 
 ### Overview
 

sp/docs/source/terraform/submodule/windmill.md

@@ -1,6 +1,4 @@
-# Windmill Module
-
-
+# Windmill 
 
 ### Overview