feat: add delivery metrics demo page and update nav (#38)

Also downgrades watchdog due to caching issue.
Closes #19

docs/delivery-demo.md

@@ -0,0 +1,38 @@
+# Delivery Metrics Demo via GitHub and OpenTelemetry
+
+## Introduction
+
+Welcome to the Delivery Metrics demo page! This demo is a fork of the
+[OpenTelemetry Demo][oteldemo] leveraging the [Liatrio OTEL
+Collector][lotelcol] distribution in an additional profile to provide the
+following additional capabilities:
+
+* Leading delivery indicators from GitHub using the Git Provider Receiver
+* DORA Metrics from GitHub through the WebHook Event Receiver
+
+[oteldemo]: https://opentelemetry.io/docs/demo/
+[lotelcol]: https://github.com/liatrio/liatrio-otel-collector
+
+At this point in time, the demo fork is only extended to work locally via Docker.
+
+## Getting Started
+
+### Prerequisites
+
+* The same set of prerequisites defined for the [OpenTelemetry Demo](https://opentelemetry.io/docs/demo/docker-deployment/#prerequisites)
+* Any prerequisites defined in the [Delivery Demo Documentation](https://github.com/liatrio/opentelemetry-demo/blob/main/docs/delivery.md)
+
+### General Commands
+
+Once those docs are reviewed and prerequisites met run either (or both):
+
+* `make start-delivery`
+* `make start-dora`
+
+If setup via the guide in the demo, then you should start to see metrics like the below screenshots by navigating to Grafana:
+
+* Grafana: http://localhost:8080/grafana/
+
+<img src="../img/delivery-metrics-dashboard-1.png" width="1000">
+<img src="../img/delivery-metrics-dashboard-2.png" width="1000">
+

mkdocs.yml

@@ -61,15 +61,18 @@ repo_url: https://github.com/liatrio/openo11y.dev
 nav:
   - "Welcome to Open O11y": "index.md"
   - "Why Metrics Matter": "./why-metrics-matter.md"
-  - "Human Systems":
-      - "Observing Human Systems": "./human-systems/observing-human-systems.md"
-      - "Delivery Metrics":
-          - "Overview": "./human-systems/delivery-metrics/overview.md"
-          - "Lagging Inidicators": "./human-systems/delivery-metrics/lagging-delivery-indicators.md"
-          - "Leading Inidicators": "./human-systems/delivery-metrics/leading-delivery-indicators.md"
-          - "DevEx & Platform": "./human-systems/delivery-metrics/devex-platform.md"
-          - "Satisfaction & Well-Being": "./human-systems/delivery-metrics/satisfaction-well-being.md"
-  - "Business Systems": "./business-systems.md"
+  - "Guidance":
+    - "Human Systems":
+        - "Observing Human Systems": "./human-systems/observing-human-systems.md"
+        - "Delivery Metrics":
+            - "Overview": "./human-systems/delivery-metrics/overview.md"
+            - "Lagging Inidicators": "./human-systems/delivery-metrics/lagging-delivery-indicators.md"
+            - "Leading Inidicators": "./human-systems/delivery-metrics/leading-delivery-indicators.md"
+            - "DevEx & Platform": "./human-systems/delivery-metrics/devex-platform.md"
+            - "Satisfaction & Well-Being": "./human-systems/delivery-metrics/satisfaction-well-being.md"
+    - "Business Systems": "./business-systems.md"
+  - "Demos":
+    - "Delivery Metrics Demo": "./delivery-demo.md"
   # - "O11y Quick Start Platform":
   #     - "Overview": "./platform/README.md"
   #     - "Architecture": "./platform/architecture.md"

pyproject.toml

@@ -13,6 +13,7 @@ readme = "README.md"
 python = "^3.11"
 mkdocs = "^1.5.2"
 mkdocs-material = "^9.1.21"
+watchdog = "~3.0.0"
 
 
 [build-system]