rename demo services

puckpuck · puckpuck · commit ff3ee1d6ab6e · 2025-03-02T00:53:33.000-05:00
diff --git a/content/en/docs/demo/requirements/architecture.md b/content/en/docs/demo/requirements/architecture.md
@@ -45,37 +45,22 @@ logs (as applicable/available).
 
 Each service should be interchangeable with a service that performs the same
 business logic, implementing the same gRPC endpoints, but written in a different
-language/implementation. For the initial implementation of the demo, we should
-focus on adding as many missing languages as possible by swapping out existing
-services with implementations in un-represented languages. For future versions
-we will look to add more distinct language options per service.
+language/implementation.
 
-Each service should communicate with a feature flag service in order to
-enable/disable 'faults' that can be used to illustrate how telemetry helps solve
-problems in distributed applications.
-
-A PHP service should be added to the main application as an 'admin service'. A
-Database should be added to enable CRUD functionality on the Product Catalog.
-
-The 'shipping' service should be reimplemented in Rust.
-
-The 'currency' service should be reimplemented in C++.
-
-The 'email' service should be reimplemented in Ruby.
-
-For future iterations, the 'frontend' service can be extended with a mobile
-application written in Swift.
+Each service should be able to communicate with a feature flag service in order
+to enable/disable faults that can be used to illustrate how telemetry helps
+solve problems in distributed applications.
 
 ## Feature Flag Component
 
 Feature flagging is a crucial part of cloud native application development. The
-demo uses OpenFeature, a CNCF incubating project, to manage feature flags.
+Demo uses OpenFeature, a CNCF incubating project, to manage feature flags.
 
 Feature flags can be set through the flagd configurator user interface.
 
 ## Orchestration and Deployment
 
-All services should run on Kubernetes. The OpenTelemetry Collector should be
+All services run on Kubernetes. The OpenTelemetry Collector should be
 deployed via the OpenTelemetry Operator, and run in a sidecar + gateway mode.
 Telemetry from each pod should be routed from agents to a gateway, and the
 gateway should export telemetry by default to an open source trace + metrics
diff --git a/content/en/docs/demo/scenarios/recommendation-cache/index.md b/content/en/docs/demo/scenarios/recommendation-cache/index.md
@@ -68,9 +68,9 @@ work, and viewing the details allows us to get a better idea of what's going on.
 ## Confirming the Diagnosis
 
 We can see in our waterfall view that the `app.cache_hit` attribute is set to
-`false`, and that the `app.products.count` value is extremely high.
+false, and that the `app.products.count` value is extremely high.
 
-Returning to the search UI, filter to `recommendation` in the Service dropdown,
+Returning to the search UI, select `recommendation` in the Service dropdown,
 and search for `app.cache_hit=true` in the Tags box. Notice that requests tend
 to be faster when the cache is hit. Now search for `app.cache_hit=false` and
 compare the latency. You should notice some changes in the visualization at the
diff --git a/content/en/docs/demo/services/accounting.md b/content/en/docs/demo/services/accounting.md
@@ -1,7 +1,7 @@
 ---
 title: Accounting Service
 linkTitle: Accounting
-aliases: [accounting]
+aliases: [accountingservice]
 ---
 
 This service calculates the total amount of sold products. This is only mocked
diff --git a/content/en/docs/demo/services/ad.md b/content/en/docs/demo/services/ad.md
@@ -1,7 +1,7 @@
 ---
 title: Ad Service
 linkTitle: Ad
-aliases: [ad]
+aliases: [adservice]
 ---
 
 This service determines appropriate ads to serve to users based on context keys.
diff --git a/content/en/docs/demo/services/cart/index.md b/content/en/docs/demo/services/cart/index.md
@@ -1,7 +1,7 @@
 ---
 title: Cart Service
 linkTitle: Cart
-aliases: [cart]
+aliases: [cartservice]
 ---
 
 This service maintains items placed in the shopping cart by users. It interacts
diff --git a/content/en/docs/demo/services/checkout.md b/content/en/docs/demo/services/checkout.md
@@ -1,7 +1,7 @@
 ---
 title: Checkout Service
 linkTitle: Checkout
-aliases: [checkout]
+aliases: [checkoutservice]
 # prettier-ignore
 cSpell:ignore: fatalf otelgrpc otelsarama otlpmetricgrpc otlptracegrpc sarama sdkmetric sdktrace
 ---
diff --git a/content/en/docs/demo/services/currency.md b/content/en/docs/demo/services/currency.md
@@ -1,7 +1,7 @@
 ---
 title: Currency Service
 linkTitle: Currency
-aliases: [currency]
+aliases: [currencyservice]
 cSpell:ignore: decltype labelkv noexcept nostd
 ---
 
diff --git a/content/en/docs/demo/services/email.md b/content/en/docs/demo/services/email.md
@@ -1,7 +1,7 @@
 ---
 title: Email Service
 linkTitle: Email
-aliases: [email]
+aliases: [emailservice]
 cSpell:ignore: sinatra
 ---
 
diff --git a/content/en/docs/demo/services/fraud-detection.md b/content/en/docs/demo/services/fraud-detection.md
@@ -1,7 +1,7 @@
 ---
 title: Fraud Detection Service
 linkTitle: Fraud Detection
-aliases: [fraud-detection]
+aliases: [frauddetectionservice]
 ---
 
 This service analyses incoming orders and detects malicious customers. This is
diff --git a/content/en/docs/demo/services/frontend-proxy.md b/content/en/docs/demo/services/frontend-proxy.md
@@ -1,7 +1,7 @@
 ---
 title: Frontend Proxy (Envoy)
 linkTitle: Frontend Proxy
-aliases: [frontend-proxy]
+aliases: [frontendproxy]
 cSpell:ignore: upstreams
 ---
 
diff --git a/content/en/docs/demo/services/image-provider.md b/content/en/docs/demo/services/image-provider.md
@@ -1,7 +1,7 @@
 ---
 title: Image Provider Service
 linkTitle: Image Provider
-aliases: [image-provider] # cSpell:disable-line
+aliases: [imageprovider] # cSpell:disable-line
 ---
 
 This service provides the images which are used in the frontend. The images are
diff --git a/content/en/docs/demo/services/load-generator.md b/content/en/docs/demo/services/load-generator.md
@@ -1,6 +1,6 @@
 ---
 title: Load Generator
-aliases: [load-generator]
+aliases: [loadgenerator]
 cSpell:ignore: instrumentor instrumentors locustfile urllib
 ---
 
diff --git a/content/en/docs/demo/services/payment.md b/content/en/docs/demo/services/payment.md
@@ -1,7 +1,7 @@
 ---
 title: Payment Service
 linkTitle: Payment
-aliases: [payment]
+aliases: [paymentservice]
 cSpell:ignore: nanos
 ---
 
diff --git a/content/en/docs/demo/services/product-catalog.md b/content/en/docs/demo/services/product-catalog.md
@@ -1,7 +1,7 @@
 ---
 title: Product Catalog Service
 linkTitle: Product Catalog
-aliases: [product-catalog]
+aliases: [productcatalogservice]
 # prettier-ignore
 cSpell:ignore: fatalf otelcodes otelgrpc otlpmetricgrpc otlptracegrpc sdkmetric sdktrace sprintf
 ---
diff --git a/content/en/docs/demo/services/quote.md b/content/en/docs/demo/services/quote.md
@@ -1,7 +1,7 @@
 ---
 title: Quote Service
 linkTitle: Quote
-aliases: [quote]
+aliases: [quoteservice]
 cSpell:ignore: getquote
 ---
 
diff --git a/content/en/docs/demo/services/recommendation.md b/content/en/docs/demo/services/recommendation.md
@@ -1,7 +1,7 @@
 ---
 title: Recommendation Service
 linkTitle: Recommendation
-aliases: [recommendation]
+aliases: [recommendationservice]
 cSpell:ignore: cpython instrumentor NOTSET
 ---
 
diff --git a/content/en/docs/demo/services/shipping.md b/content/en/docs/demo/services/shipping.md
@@ -1,7 +1,7 @@
 ---
 title: Shipping Service
 linkTitle: Shipping
-aliases: [shipping]
+aliases: [shippingservice]
 cSpell:ignore: itemct oteldemo reqwest sdktrace semcov shiporder tokio
 ---
 
@@ -116,8 +116,8 @@ will work.
 
 ### Adding HTTP instrumentation
 
-A child _client_ span is also produced for the outgoing HTTP call to `quote` via
-the `reqwest` client. This span pairs up with the corresponding `quote` _server_
+A child _client_ span is also produced for the outgoing HTTP call to quote via
+the `reqwest` client. This span pairs up with the corresponding quote _server_
 span. The tracing instrumentation is implemented in the client middleware making
 use of the available `reqwest-middleware`, `reqwest-tracing` and
 `tracing-opentelemetry` libraries:
diff --git a/content/en/docs/demo/telemetry-features/manual-span-attributes.md b/content/en/docs/demo/telemetry-features/manual-span-attributes.md
@@ -5,7 +5,7 @@ aliases: [manual_span_attributes, ../manual-span-attributes]
 
 This page lists the manual Span Attributes used throughout the demo:
 
-## Ad Service
+## Ad
 
 | Name                        | Type   | Description                           |
 | --------------------------- | ------ | ------------------------------------- |
@@ -16,7 +16,7 @@ This page lists the manual Span Attributes used throughout the demo:
 | `app.ads.ad_request_type`   | string | Either `targeted` or `not_targeted`   |
 | `app.ads.ad_response_type`  | string | Either `targeted` or `random`         |
 
-## Cart Service
+## Cart
 
 | Name                   | Type   | Description                    |
 | ---------------------- | ------ | ------------------------------ |
@@ -25,7 +25,7 @@ This page lists the manual Span Attributes used throughout the demo:
 | `app.product.quantity` | string | Quantity for cart item         |
 | `app.user.id`          | string | User ID                        |
 
-## Checkout Service
+## Checkout
 
 | Name                         | Type   | Description                     |
 | ---------------------------- | ------ | ------------------------------- |
@@ -39,14 +39,14 @@ This page lists the manual Span Attributes used throughout the demo:
 | `app.user.currency`          | string | User currency                   |
 | `app.user.id`                | string | User ID                         |
 
-## Currency Service
+## Currency
 
 | Name                           | Type   | Description                   |
 | ------------------------------ | ------ | ----------------------------- |
 | `app.currency.conversion.from` | string | Currency code to convert from |
 | `app.currency.conversion.to`   | string | Currency code to convert to   |
 
-## Email Service
+## Email
 
 | Name                  | Type   | Description                       |
 | --------------------- | ------ | --------------------------------- |
@@ -77,7 +77,7 @@ This page lists the manual Span Attributes used throughout the demo:
 | -------- | ---- | ----------- |
 | None yet |      |             |
 
-## Payment Service
+## Payment
 
 | Name                     | Type    | Description                                           |
 | ------------------------ | ------- | ----------------------------------------------------- |
@@ -86,7 +86,7 @@ This page lists the manual Span Attributes used throughout the demo:
 | `app.payment.card_valid` | boolean | Was the card used valid                               |
 | `app.payment.charged`    | boolean | Was the charge successful (false with load generator) |
 
-## Product Catalog Service
+## Product Catalog
 
 | Name                        | Type   | Description                           |
 | --------------------------- | ------ | ------------------------------------- |
@@ -95,14 +95,14 @@ This page lists the manual Span Attributes used throughout the demo:
 | `app.products.count`        | number | Number of products in catalog         |
 | `app.products_search.count` | number | Number of products returned in search |
 
-## Quote Service
+## Quote
 
 | Name                    | Type   | Description          |
 | ----------------------- | ------ | -------------------- |
 | `app.quote.items.count` | number | Total items to ship  |
 | `app.quote.cost.total`  | number | Total shipping quote |
 
-## Recommendation Service
+## Recommendation
 
 | Name                             | Type    | Description                             |
 | -------------------------------- | ------- | --------------------------------------- |
@@ -111,7 +111,7 @@ This page lists the manual Span Attributes used throughout the demo:
 | `app.products_recommended.count` | number  | Number of recommended products returned |
 | `app.cache_hit`                  | boolean | If cache was accessed or not            |
 
-## Shipping Service
+## Shipping
 
 | Name                       | Type   | Description                   |
 | -------------------------- | ------ | ----------------------------- |
