diff --git a/docs/concepts.md b/docs/concepts.md index 0ed2af3..fa7f567 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -105,7 +105,20 @@ All the modules come with end-to-end deployable examples. You can find **workload** examples like [Amazon EKS infrastructure monitoring](https://aws-observability.github.io/terraform-aws-observability-accelerator/eks/) or [monitoring your Amazon Managed Service for Prometheus workspace](https://aws-observability.github.io/terraform-aws-observability-accelerator/workloads/managed-prometheus/) and more. -![example diagram](images/example-diagram.svg) +``` mermaid +classDiagram + Example <|-- Base Module + Example <|-- Workload Module + class Base Module{ + Amazon Managed Prometheus + Amazon Managed Grafana Data Sources + } + class Workload Module{ + Amazon Distro for Open Telemetry Config + Amazon Managed Prometheus Alerts + Amazon Managed Grafana Dashboards + } +``` ## Getting started with AWS Observability services diff --git a/docs/images/example-diagram.svg b/docs/images/example-diagram.svg deleted file mode 100644 index c1364f4..0000000 --- a/docs/images/example-diagram.svg +++ /dev/null @@ -1 +0,0 @@ -
Example
BaseModule
Amazon Managed Prometheus
Amazon Distro for Open Telemetry
WorkloadModule
Amazon Distro for Open Telemetry Config
Amazon Managed Grafana Dashboards
Amazon Managed Prometheus Alerts
diff --git a/mkdocs.yml b/mkdocs.yml index 8efe42d..d6860ca 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -44,6 +44,11 @@ markdown_extensions: - codehilite - footnotes - pymdownx.critic + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format plugins: - search