Docs

kadreio · Oct 29, 2024 · e5edca1 · e5edca1
1 parent a11e0c5
commit e5edca1
Show file tree

Hide file tree

Showing 14 changed files with 46 additions and 1 deletion.
diff --git a/doc_site/docs/requirements.txt b/doc_site/docs/requirements.txt
@@ -1,4 +1,5 @@
 sphinx==7.3.0
 # sphinx-rtd-theme==1.3.0rc1
 sphinxawesome-theme==5.2.0
-myst-parser
+myst-parser
+sphinx-design
diff --git a/doc_site/docs/source/conf.py b/doc_site/docs/source/conf.py
@@ -73,9 +73,11 @@ def get_latest_git_tag():
     'sphinx.ext.extlinks',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
+    'sphinx_design',
     'myst_parser'
 
 ]
+myst_enable_extensions = ["colon_fence"]
 
 source_suffix = {
     '.rst': 'restructuredtext',

diff --git a/doc_site/docs/source/partials/status_beta.md b/doc_site/docs/source/partials/status_beta.md
@@ -0,0 +1 @@
+{bdg-warning}`Beta`
diff --git a/doc_site/docs/source/partials/status_development.md b/doc_site/docs/source/partials/status_development.md
@@ -0,0 +1,2 @@
+{bdg-danger}`In Development`
+
diff --git a/doc_site/docs/source/partials/status_release.md b/doc_site/docs/source/partials/status_release.md
@@ -0,0 +1 @@
+{bdg-success}`Released`
diff --git a/doc_site/docs/source/terraform/submodule/airbyte.md b/doc_site/docs/source/terraform/submodule/airbyte.md
@@ -1,5 +1,8 @@
 # Airbyte 
 
+
+{bdg-warning}`Beta`
+
 ### Overview
 
 This module deploys Airbyte, an open-source data integration platform, on Kubernetes. It sets up the necessary Helm release, configures the database, and exposes the Airbyte webserver. This module also includes OAuth2 proxy configuration for secure access.

diff --git a/doc_site/docs/source/terraform/submodule/clickhouse.md b/doc_site/docs/source/terraform/submodule/clickhouse.md
@@ -1,5 +1,15 @@
 # Clickhouse 
 
+Hi 
+{bdg-primary}`primary`, {bdg-primary-line}`primary-line`
+
+```{bdg-primary}
+primary
+```
+
+```{bdg-primary-line}
+primary-line
+```
 ### Overview
 
 This module deploys a ClickHouse database on Kubernetes. It uses the official ClickHouse Helm chart to set up a reliable columnar database instance, suitable for high-performance analytics and data warehousing in the cluster. The module also provides outputs for easy access to database connection details.

diff --git a/modules/airbyte/.terraform-docs.yml b/modules/airbyte/.terraform-docs.yml
@@ -1,7 +1,10 @@
 formatter: "markdown table"
 
 content: |-
+
   {{ .Header }}
+  
+  {{ include "../../doc_site/docs/source/partials/status_beta.md" }}
 
   ## Overview
 

diff --git a/modules/airbyte/README.md b/modules/airbyte/README.md
@@ -1,5 +1,8 @@
 # Airbyte 
 
+
+{bdg-warning}`Beta`
+
 ### Overview
 
 This module deploys Airbyte, an open-source data integration platform, on Kubernetes. It sets up the necessary Helm release, configures the database, and exposes the Airbyte webserver. This module also includes OAuth2 proxy configuration for secure access.

diff --git a/modules/argo_cd/.terraform-docs.yml b/modules/argo_cd/.terraform-docs.yml
@@ -2,11 +2,14 @@ formatter: "markdown table"
 
 content: |-
   {{ .Header }}
+  
+  {{ include "../../doc_site/docs/source/partials/status_release.md" }}
 
   ## Overview
 
   This module deploys Argo CD, a declarative, GitOps continuous delivery tool for Kubernetes. It sets up the necessary Helm release, configures SSO integration, and exposes the Argo CD server. The module includes OAuth2 configuration for secure access.
 
+
   ```{tip}
     This implementation uses the official Argo CD Helm chart. You can find more details in the [Argo CD documentation](https://github.com/argoproj/argo-helm/tree/main/charts/argo-cd).
 

diff --git a/modules/argo_workflows/.terraform-docs.yml b/modules/argo_workflows/.terraform-docs.yml
@@ -2,6 +2,8 @@ formatter: "markdown table"
 
 content: |-
   {{ .Header }}
+  
+  {{ include "../../doc_site/docs/source/partials/status_release.md" }}
 
   ## Overview
 

diff --git a/modules/clickhouse/.terraform-docs.yml b/modules/clickhouse/.terraform-docs.yml
@@ -2,6 +2,8 @@ formatter: "markdown table"
 
 content: |-
   {{ .Header }}
+  
+  {{ include "../../doc_site/docs/source/partials/status_development.md" }}
 
   ## Overview
 

diff --git a/modules/clickhouse/README.md b/modules/clickhouse/README.md
@@ -1,5 +1,15 @@
 # Clickhouse 
 
+Hi 
+{bdg-primary}`primary`, {bdg-primary-line}`primary-line`
+
+```{bdg-primary}
+primary
+```
+
+```{bdg-primary-line}
+primary-line
+```
 ### Overview
 
 This module deploys a ClickHouse database on Kubernetes. It uses the official ClickHouse Helm chart to set up a reliable columnar database instance, suitable for high-performance analytics and data warehousing in the cluster. The module also provides outputs for easy access to database connection details.

diff --git a/modules/superset/.terraform-docs.yml b/modules/superset/.terraform-docs.yml
@@ -2,6 +2,8 @@ formatter: "markdown table"
 
 content: |-
   {{ .Header }}
+  
+  {{ include "../../doc_site/docs/source/partials/status_release.md" }}
 
   ## Overview