Merge pull request #151 from Howlla/docsEmbedding

Embedded mkdocs from observability-accelerator project
aws-samples · Oct 23, 2023 · 8bfdc8f · 8bfdc8f
2 parents 348dfaa + e065bbc
commit 8bfdc8f
Show file tree

Hide file tree

Showing 18 changed files with 42 additions and 10 deletions.
diff --git a/.github/workflows/docbuild.yml b/.github/workflows/docbuild.yml
@@ -15,4 +15,5 @@ jobs:
         with:
           python-version: 3.x
       - run: pip install mkdocs-material
+      - run: pip install mkdocs-embed-external-markdown
       - run: mkdocs gh-deploy --force
diff --git a/docs/patterns/observability/existing-eks-apiserver-observability.md b/docs/patterns/observability/existing-eks-apiserver-observability.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/existing-eks-observability-accelerators/existing-eks-apiserver-observability.md', '') }}
diff --git a/docs/patterns/observability/existing-eks-awsnative-observability.md b/docs/patterns/observability/existing-eks-awsnative-observability.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/existing-eks-observability-accelerators/existing-eks-awsnative-observability.md', '') }}
diff --git a/docs/patterns/observability/existing-eks-mixed-observability.md b/docs/patterns/observability/existing-eks-mixed-observability.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/existing-eks-observability-accelerators/existing-eks-mixed-observability.md', '') }}
diff --git a/docs/patterns/observability/existing-eks-nginx-observability.md b/docs/patterns/observability/existing-eks-nginx-observability.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/existing-eks-observability-accelerators/existing-eks-nginx-observability.md', '') }}
diff --git a/docs/patterns/observability/existing-eks-opensource-observability.md b/docs/patterns/observability/existing-eks-opensource-observability.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/existing-eks-observability-accelerators/existing-eks-opensource-observability.md', '') }}
diff --git a/docs/patterns/observability/multi-acc-new-eks-mixed-observability.md b/docs/patterns/observability/multi-acc-new-eks-mixed-observability.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/multi-new-eks-observability-accelerators/multi-acc-new-eks-mixed-observability.md', '') }}
diff --git a/docs/patterns/multi-account-monitoring.md → ...observability/multi-account-monitoring.md b/docs/patterns/multi-account-monitoring.md → ...observability/multi-account-monitoring.md
@@ -4,7 +4,7 @@
 
 The following figure illustrates the architecture of the pattern we will be deploying for Multi Account Observability pattern using open source tooling such as AWS Distro for Open Telemetry (ADOT), Amazon Managed Service for Prometheus (AMP), Amazon Managed Grafana :
 
-![Architecture](./images/setup_amg-cross-account.png)
+![Architecture](../images/setup_amg-cross-account.png)
 
 ## Objective
 
@@ -236,9 +236,9 @@ You can find the team-geordie configuration for this pattern in the workload rep
     2. Query metrics in Monitoring account from Amazon Managed Prometheus workspace in Prod 1 Account
     3. Query metrics in the Monitoring account from Amazon CloudWatch in Prod 1 Account
 
-![Metrics from AMP](./images/AMG%20-%20Metrics%20from%20AMP.png)
+![Metrics from AMP](../images/AMG%20-%20Metrics%20from%20AMP.png)
 
-![Metrics from CloudWatch](./images/AMG%20-%20Metrics%20from%20CloudWatch.png)
+![Metrics from CloudWatch](../images/AMG%20-%20Metrics%20from%20CloudWatch.png)
 
 ### Validating Custom Metrics and Traces from ho11y App
 
@@ -256,17 +256,17 @@ You can find the team-geordie configuration for this pattern in the workload rep
     ```
 ### Traces and Service Map screenshots from X-Ray Console
 
-![Traces of ho11y App on X-Ray Console](./images/XRAY%20-%20Traces.png)
+![Traces of ho11y App on X-Ray Console](../images/XRAY%20-%20Traces.png)
 
-![Service Map of ho11y App on X-Ray Console](./images/XRAY%20-%20Service%20Map.png)
+![Service Map of ho11y App on X-Ray Console](../images/XRAY%20-%20Service%20Map.png)
 
 ### Custom Metrics from ho11y App on Amazon Managed Grafana Console using AMP as data source
 
-![Exploring Metrics from ho11y with AMP as Data source in AMG Console](./images/Explore%20AMG.png)
+![Exploring Metrics from ho11y with AMP as Data source in AMG Console](../images/Explore%20AMG.png)
 
 ### Custom Metrics from ho11y App on Amazon Managed Grafana Console using CloudWatch as data source
 
-![Exploring Metrics from ho11y with CloudWatch as Data source in AMG Console](./images/Explore%20AMG.png)
+![Exploring Metrics from ho11y with CloudWatch as Data source in AMG Console](../images/Explore%20AMG.png)
 
 ### Notes
 

diff --git a/docs/patterns/observability/single-new-eks-apiserver-opensource-observability.md b/docs/patterns/observability/single-new-eks-apiserver-opensource-observability.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/single-new-eks-observability-accelerators/single-new-eks-apiserver-opensource-observability.md', '') }}
diff --git a/docs/patterns/observability/single-new-eks-awsnative-fargate-observability.md b/docs/patterns/observability/single-new-eks-awsnative-fargate-observability.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/single-new-eks-observability-accelerators/single-new-eks-awsnative-fargate-observability.md', '') }}
diff --git a/docs/patterns/observability/single-new-eks-gpu-opensource-observability.md b/docs/patterns/observability/single-new-eks-gpu-opensource-observability.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/single-new-eks-observability-accelerators/single-new-eks-gpu-opensource-observability.md', '') }}
diff --git a/docs/patterns/observability/single-new-eks-graviton-opensource-observability.md b/docs/patterns/observability/single-new-eks-graviton-opensource-observability.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/single-new-eks-observability-accelerators/single-new-eks-graviton-opensource-observability.md', '') }}
diff --git a/docs/patterns/observability/single-new-eks-java-opensource-observability.md b/docs/patterns/observability/single-new-eks-java-opensource-observability.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/single-new-eks-observability-accelerators/single-new-eks-java-opensource-observability.md', '') }}
diff --git a/docs/patterns/observability/single-new-eks-mixed-observability.md b/docs/patterns/observability/single-new-eks-mixed-observability.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/single-new-eks-observability-accelerators/single-new-eks-mixed-observability.md', '') }}
diff --git a/docs/patterns/observability/single-new-eks-native.md b/docs/patterns/observability/single-new-eks-native.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/single-new-eks-observability-accelerators/single-new-eks-awsnative-observability.md', '') }}
diff --git a/docs/patterns/observability/single-new-eks-nginx-opensource-observability.md b/docs/patterns/observability/single-new-eks-nginx-opensource-observability.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/single-new-eks-observability-accelerators/single-new-eks-nginx-opensource-observability.md', '') }}
diff --git a/docs/patterns/observability/single-new-eks-opensource.md b/docs/patterns/observability/single-new-eks-opensource.md
@@ -0,0 +1 @@
+{{ external_markdown('https://raw.githubusercontent.com/aws-observability/cdk-aws-observability-accelerator/main/docs/patterns/single-new-eks-observability-accelerators/single-new-eks-opensource-observability.md', '') }}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -12,9 +12,24 @@ nav:
     - Generative AI:
       - Prompt Showcase Pattern: 'patterns/generative-ai/showcase.md'
     - Observability Patterns:
-      - AWS Native Observability Pattern: 'https://github.com/aws-observability/cdk-aws-observability-accelerator/blob/main/docs/patterns/single-new-eks-observability-accelerators/single-new-eks-awsnative-observability.md'
-      - Opensource Observability Pattern: 'https://github.com/aws-observability/cdk-aws-observability-accelerator/blob/main/docs/patterns/single-new-eks-observability-accelerators/single-new-eks-opensource-observability.md'
-      - Multi Account Observability Pattern: 'patterns/multi-account-monitoring.md'
+      - New Cluster:
+        - AWS Native Observability Pattern: 'patterns/observability/single-new-eks-native.md'
+        - AWS Graviton Observability Pattern: 'patterns/observability/single-new-eks-graviton-opensource-observability.md'
+        - OSS Observability Pattern: 'patterns/observability/single-new-eks-opensource.md'
+        - Fargate Observability Pattern : patterns/observability/single-new-eks-awsnative-fargate-observability.md
+        - Mixed Observability Pattern: patterns/observability/single-new-eks-mixed-observability.md
+        - Multi-Cluster Multi-Region Monitoring : patterns/observability/multi-acc-new-eks-mixed-observability.md
+        - OSS Apiserver Monitoring: patterns/observability/single-new-eks-apiserver-opensource-observability.md
+        - OSS GPU Monitoring: patterns/observability/single-new-eks-gpu-opensource-observability.md
+        - OSS Java Monitoring : patterns/observability/single-new-eks-java-opensource-observability.md
+        - OSS Nginx Monitoring : patterns/observability/single-new-eks-nginx-opensource-observability.md
+      - Existing Cluster:
+        - AWS Native Observability Pattern : patterns/observability/existing-eks-awsnative-observability.md
+        - Mixed Observability Pattern: patterns/observability/existing-eks-mixed-observability.md
+        - OSS Observability Pattern: patterns/observability/existing-eks-opensource-observability.md
+        - OSS Apiserver Monitoring : patterns/observability/existing-eks-apiserver-observability.md
+        - OSS Nginx Monitoring : patterns/observability/existing-eks-nginx-observability.md
+      - Multi Account Observability Pattern: 'patterns/observability/multi-account-monitoring.md'
     - Security Patterns:
       - EKS Config Rules: 'patterns/security/eks-config-rules.md'
       - Encryption At Rest: 'patterns/security/encryption-at-rest.md'
@@ -51,3 +66,4 @@ markdown_extensions:
       permalink: "¤"
 plugins:
   - search
+  - external-markdown