Skip to content

Commit 5884a4f

Browse files
chalinchalin
authored
Demo docs: left-nav fixes (open-telemetry#2275)
1 parent 880f269 commit 5884a4f

31 files changed

+55
-47
lines changed

‎content/en/docs/demo/_index.md

+8-14
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,22 @@
11
---
22
title: OpenTelemetry Demo Documentation
3-
linkTitle: Demo Documentation
3+
linkTitle: Demo
4+
cascade:
5+
repo: https://github.com/open-telemetry/opentelemetry-demo
46
---
57

68
Welcome to the OpenTelemetry Demo! This folder contains overall documentation
79
for the project, how to install and run it, and some scenarios you can use to
810
view OpenTelemetry in action.
911

10-
## Table of Contents
11-
12-
- [Guided Scenarios](#scenarios)
13-
- [Language Instrumentation Examples](#language-feature-reference)
14-
- [Quick Start](#running-the-demo)
15-
- [References](#reference)
16-
- [Service Documentation](#service-documentation)
17-
18-
### Running the Demo
12+
## Running the Demo
1913

2014
Want to deploy the demo and see it in action? Start here.
2115

2216
- [Docker]({{% relref "./docker_deployment.md" %}})
2317
- [Kubernetes]({{% relref "./kubernetes_deployment.md" %}})
2418

25-
### Language Feature Reference
19+
## Language Feature Reference
2620

2721
Want to understand how a particular language's instrumentation works? Start
2822
here.
@@ -41,7 +35,7 @@ here.
4135
| Ruby | [Email Service]({{% relref "services/emailservice/" %}}) | [Email Service]({{% relref "services/emailservice/" %}}) |
4236
| Rust | [Shipping Service]({{% relref "services/shippingservice/" %}}) | [Shipping Service]({{% relref "services/shippingservice/" %}}) |
4337

44-
### Service Documentation
38+
## Service Documentation
4539

4640
Specific information about how OpenTelemetry is deployed in each service can be
4741
found here:
@@ -59,7 +53,7 @@ found here:
5953
- [Recommendation Service]({{% relref "services/recommendationservice/" %}})
6054
- [Shipping Service]({{% relref "services/shippingservice/" %}})
6155

62-
### Scenarios
56+
## Scenarios
6357

6458
How can you solve problems with OpenTelemetry? These scenarios walk you through
6559
some pre-configured problems and show you how to interpret OpenTelemetry data to
@@ -71,7 +65,7 @@ We'll be adding more scenarios over time.
7165
with product id: `OLJCESPC7Z` using the Feature Flag service
7266
- Discover a memory leak and diagnose it using metrics and traces. [Read more]({{% relref "./scenarios/recommendation_cache.md" %}})
7367

74-
### Reference
68+
## Reference
7569

7670
Project reference documentation, like requirements and feature matrices.
7771

‎content/en/docs/demo/current_architecture.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Demo Architecture
3+
linkTitle: Architecture
34
---
45

56
**OpenTelemetry Demo** is composed of microservices written in different programming

‎content/en/docs/demo/demo_features.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Features
2+
title: Demo Features
3+
linkTitle: Features
34
---
45

56
- **[Kubernetes](https://kubernetes.io)**: the app is designed to run on

‎content/en/docs/demo/demo_screenshots.md

+1-8
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,8 @@
11
---
22
title: Demo Screenshots
3+
linkTitle: Screenshots
34
---
45

5-
- [Demo Screenshots](.)
6-
- [Webstore](#webstore)
7-
- [Jaeger](#jaeger)
8-
- [Prometheus](#prometheus)
9-
- [Grafana](#grafana)
10-
- [Feature Flag UI](#feature-flag-ui)
11-
- [Load Generator UI](#load-generator-ui)
12-
136
## Webstore
147

158
| Home Page | Checkout Screen |

‎content/en/docs/demo/docker_deployment.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Docker
2+
title: Docker deployment
3+
linkTitle: Docker
34
---
45

56
## Prerequisites

‎content/en/docs/demo/forking.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
2-
title: Forking this Repository
2+
title: Forking the demo repository
3+
linkTitle: Forking
34
---
45

5-
This repository is designed to be forked and used as a tool to show off what you
6-
are doing with OpenTelemetry.
6+
The [demo repository][] is designed to be forked and used as a tool to show off
7+
what you are doing with OpenTelemetry.
78

89
Setting up a fork or a demo usually only requires overriding some environment
910
variables and possibly replacing some container images.
1011

11-
Live demos can be added to the
12-
[README](https://github.com/open-telemetry/opentelemetry-demo/blob/main/_index.md?plain=1#L186).
12+
Live demos can be added to the demo
13+
[README](https://github.com/open-telemetry/opentelemetry-demo/blob/main/README.md?plain=1).
1314

1415
## Suggestions for Fork Maintainers
1516

@@ -28,3 +29,5 @@ Live demos can be added to the
2829

2930
If you have any questions or would like to suggest ways that we can make your
3031
life easier as a fork maintainer, please open an issue.
32+
33+
[demo repository]: {{% param repo %}}

‎content/en/docs/demo/kubernetes_deployment.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Kubernetes
2+
title: Kubernetes deployment
3+
linkTitle: Kubernetes
34
---
45

56
We provide a [OpenTelemetry Demo Helm

‎content/en/docs/demo/metric_service_features.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Metric Feature Coverage by Service
3+
linkTitle: Metric Feature Coverage
34
---
45

56
Emoji Legend

‎content/en/docs/demo/requirements/_index.md

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
---
2-
title: OpenTelemetry Community Demo Requirements
3-
linkTitle: Community Demo Requirements
2+
title: Demo Requirements
3+
linkTitle: Requirements
44
---
55

66
The following documents capture the Application, OpenTelemetry (OTel), and System
77
requirements for our shared demo application. These were decided upon in the
88
ongoing SIG meeting.
99

1010
1. [Application Requirements]({{% relref "./application_requirements.md" %}})
11-
1211
2. [OpenTelemetry Requirements]({{% relref "./opentelemetry_requirements.md" %}})
13-
1412
3. [System Requirements]({{% relref "./system_requirements.md" %}})
1513

1614
## Target Personas
@@ -19,12 +17,9 @@ We're building the demo application with several different target personas in mi
1917

2018
1. **Enthusiasts** at a company that can use the demo app as an individual to
2119
advocate for OTel within their organization.
22-
2320
2. **Developers** with specific language skills who want to see a larger picture
2421
view.
25-
2622
3. **APM Vendors** who can evaluate OTel in general or need to produce a demo of
2723
their OTel capabilities for customers.
28-
2924
4. **Enterprises** considering adopting OTel and interested in understanding
3025
what a production-lite experience would be.

‎content/en/docs/demo/requirements/application_requirements.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Application Requirements
3+
title: Application
34
---
45

56
The following requirements were decided upon to define what OpenTelemetry (OTel)

‎content/en/docs/demo/requirements/architecture_requirements.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Demo Architecture
2+
title: Architecture Requirements
3+
linkTitle: Architecture
34
---
45

56
## Summary

‎content/en/docs/demo/requirements/opentelemetry_requirements.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: OpenTelemetry Requirements
3-
linkTitle: Requirements
3+
linkTitle: OTel Requirements
44
---
55

66
The following requirements were decided upon to define what OpenTelemetry (OTel)
@@ -9,19 +9,13 @@ added:
99

1010
1. The demo must produce OTel logs, traces, & metrics out of the box for
1111
languages that have a GA SDK.
12-
1312
2. Languages that have a Beta SDK available may be included but are not required
1413
like GA SDKs.
15-
1614
3. Native OTel metrics should be produced where possible.
17-
1815
4. Both manual instrumentation and instrumentation libraries
1916
(auto-instrumentation) should be demonstrated in each language.
20-
2117
5. All data should be exported to the Collector first.
22-
2318
6. The Collector must be configurable to allow for a variety of consumption
2419
experiences but default tools must be selected for each signal.
25-
2620
7. The demo application architecture using the Collector should be designed to
2721
be a best practices reference architecture.

‎content/en/docs/demo/requirements/system_requirements.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: System Requirements
3+
linkTitle: System
34
---
45

56
To ensure the demo runs correctly please ensure your environment meets the
67
following system requirements:
78

89
1. Your system must meet [Docker Desktop](https://docs.docker.com/desktop)
910
system requirements or you should use your preferred Cloud Service.
10-
1111
2. The demo must be able to work on the following Operating Systems (OS):
1212
Linux, macOS and Windows with documentation provided for each OS.

‎content/en/docs/demo/scenarios/_index.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: Scenarios
3+
---

‎content/en/docs/demo/scenarios/recommendation_cache.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Using Metrics and Traces to diagnose a memory leak
3+
linkTitle: Diagnosing memory leaks
34
---
45

56
Application telemetry, such as the kind that OpenTelemetry can provide, is very

‎content/en/docs/demo/services/_index.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: Services
3+
---

‎content/en/docs/demo/services/accountingservice.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Accounting Service
3+
linkTitle: Accounting
34
---
45

56
This service calculates the total amount of sold products.

‎content/en/docs/demo/services/adservice.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Ad Service
3+
linkTitle: Ad
34
---
45

56
This service determines appropriate ads to serve to users based on context

‎content/en/docs/demo/services/cartservice.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Cart Service
3+
linkTitle: Cart
34
---
45

56
This service maintains items placed in the shopping cart by users. It interacts

‎content/en/docs/demo/services/checkoutservice.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Checkout Service
3+
linkTitle: Checkout
34
---
45

56
This service is responsible to process a checkout order from the user. The

‎content/en/docs/demo/services/currencyservice.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Currency Service
3+
linkTitle: Currency
34
---
45

56
This service provides functionality to convert amounts between different

‎content/en/docs/demo/services/emailservice.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Email Service
3+
linkTitle: Email
34
---
45

56
This service will send a confirmation email to the user when an order is placed.

‎content/en/docs/demo/services/featureflagservice.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Feature Flag Service
3+
linkTitle: Feature Flag
34
---
45

56
This service is written in Erlang/Elixir and it is responsible for creating,

‎content/en/docs/demo/services/frauddetectionservice.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Fraud Detection Service
3+
linkTitle: Fraud Detection
34
---
45

56
This service analyses incoming orders and detects malicious customers.

‎content/en/docs/demo/services/frontendproxy.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Frontend Proxy(Envoy)
2+
title: Frontend Proxy (Envoy)
3+
linkTitle: Frontend Proxy
34
---
45

56
The frontend proxy is used as a reverse proxy for user-facing web

‎content/en/docs/demo/services/paymentservice.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Payment Service
3+
linkTitle: Payment
34
---
45

56
This service is responsible to process credit card payments for orders. It will

‎content/en/docs/demo/services/productcatalogservice.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Product Catalog Service
3+
linkTitle: Product Catalog
34
---
45

56
This service is responsible to return information about products. The service

‎content/en/docs/demo/services/quoteservice.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Quote Service
3+
linkTitle: Quote
34
---
45

56
This service is responsible for calculating shipping costs, based on

‎content/en/docs/demo/services/recommendationservice.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Recommendation Service
3+
linkTitle: Recommendation
34
---
45

56
This service is responsible to get a list of recommended products for the user

‎content/en/docs/demo/services/shippingservice.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Shipping Service
3+
linkTitle: Shipping
34
---
45

56
This service is responsible for providing shipping information including pricing

‎content/en/docs/demo/trace_service_features.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Trace Feature Coverage by Service
3+
linkTitle: Trace Feature Coverage
34
---
45

56
Emoji Legend

0 commit comments

Comments
 (0)