Skip to content

Commit b235f89

Browse files
authored
feat: update delivery-demo to reference tag-o11y-quickstart-manifests (#79)
feat: change delivery-demo to reference tag-o11y-quickstart-manifests
1 parent e2fc60b commit b235f89

File tree

1 file changed

+9
-16
lines changed

1 file changed

+9
-16
lines changed

docs/delivery-demo.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,33 @@
22

33
## Introduction
44

5-
Welcome to the Delivery Metrics demo page! This demo is a fork of the
6-
[OpenTelemetry Demo][oteldemo] leveraging the [Liatrio OTEL Collector][lotelcol]
7-
distribution in an additional profile to provide the following additional
8-
capabilities:
5+
Welcome to the Delivery Metrics demo page! This demo will use [tag-o11y-quickstart-manifests][quickstart] to spin
6+
quickly spin up a delivery demo leveraging the [Liatrio OTEL Collector][lotelcol] distribution in an additional profile to provide the following additional capabilities:
97

10-
* Leading delivery indicators from GitHub using the Git Provider Receiver
8+
* Leading delivery indicators from GitHub using the Git Hub Receiver
119
* DORA Metrics from GitHub through the WebHook Event Receiver
1210

13-
At this point in time, the demo fork is only extended to work locally via
14-
Docker.
1511

1612
## Getting Started
1713

1814
### Prerequisites
19-
20-
* The same set of prerequisites defined for the [OpenTelemetry Demo][oteldemoreqs]
21-
* Clone the [Liatrio OpenTelemetry Demo][loteldemo] using git
22-
* Any prerequisites defined in the [Delivery Demo Documentation][loteldemoreqs]
15+
* Clone the [tag-o11y-quickstart-manifests][quickstart] using git
16+
* A local kubernetes cluster
17+
* Any prerequisites listen in the [tag-o11y-quickstart-manifests][quickstart] docs
2318

2419
### General Commands
2520

26-
Once those docs are reviewed and prerequisites met run either (or both):
21+
Once those docs are reviewed and prerequisites met run:
2722

28-
* `make start-delivery`
29-
* `make start-dora`
23+
* `make ghr`
3024

3125
If setup via the guide in the demo, then you should start to see metrics like
3226
the below screenshots by navigating to Grafana:
3327

3428
* Grafana: <http://localhost:8080/grafana/>
3529

36-
![Delivery Metrics Dashboard](img/delivery-metrics-dashboard-1.png "Delivery Metrics Dashboard")
37-
![Delivery Metrics Dashboard](img/delivery-metrics-dashboard-2.png "Delivery Metrics Dashboard")
3830

31+
[quickstart]: https://github.com/liatrio/tag-o11y-quick-start-manifests
3932
[lotelcol]: https://github.com/liatrio/liatrio-otel-collector
4033
[loteldemo]: https://github.com/liatrio/opentelemetry-demo
4134
[loteldemoreqs]: https://github.com/liatrio/opentelemetry-demo/blob/main/docs/delivery.md#pre-requisites

0 commit comments

Comments
 (0)