Skip to content

Commit

Permalink
modular docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jmichalak-fluxninja committed Mar 12, 2024
1 parent 610d202 commit d21a491
Show file tree
Hide file tree
Showing 22 changed files with 29 additions and 21 deletions.
8 changes: 8 additions & 0 deletions src/a.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/bin/bash

# Iterate over each markdown file in the current directory
for file in *; do
NAME="$(basename $file service)"
# Copy a template YAML file to the new directory
sed -i "s|jmichalak9/opentelemetry.io/|jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/$NAME|g" $file/backstage.yaml #> "$file/backstage.yaml"
done
2 changes: 1 addition & 1 deletion src/accountingservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: accountingservice
description: This service calculates the total amount of sold products. This is only mocked and received orders are printed out.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/accounting
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/adservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: adservice
description: TXhis service determines appropriate ads to serve to users based on context keys. The ads will be for products available in the store.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/adservice
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/adtree/main/content/en/docs/demo/services/adservice
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/cartservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: cartservice
description: This service maintains items placed in the shopping cart by users. It interacts with a Redis caching service for fast access to shopping cart data.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/cart
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/checkoutservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: checkoutservice
description: This service is responsible to process a checkout order from the user. The checkout service will call many other services in order to process an order.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/checkout
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/currencyservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: currencyservice
description: This service provides functionality to convert amounts between different currencies.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/currency
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/emailservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: emailservice
description: This service will send a confirmation email to the user when an order is placed.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/email
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/featureflagservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: featureflagservice
description: This service is written in Erlang/Elixir and it is responsible for creating, reading, updating and deleting feature flags in a PostgreSQL DB. It is called by Product Catalog and Shipping services.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/featureflag
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/ffspostgres/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: ffspostgres
description: This resource is a relational database.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/ffspostgres
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: database
Expand Down
2 changes: 1 addition & 1 deletion src/frauddetectionservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: frauddetectionservice
description: This service analyses incoming orders and detects malicious customers. This is only mocked and received orders are printed out.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/frauddetection
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/frontend/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: frontend
description: The frontend is responsible to provide a UI for users, as well as an API leveraged by the UI or other clients. The application is based on Next.JS to provide a React web-based UI and API routes.

Check failure on line 6 in src/frontend/backstage.yaml

View workflow job for this annotation

GitHub Actions / yamllint

6:201 [line-length] line too long (209 > 200 characters)
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/frontend
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/frontendproxy/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: frontendproxy
description: This service acts as a reverse proxy for the various user-facing web interfaces.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/frontendproxy
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/grafana/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: grafana
description: This service is responsible to show metrics.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/grafana
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/kafka/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: kafka
description: This is used as a message queue service to connect the checkout service with the accounting and fraud detection services.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/kafka
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: database
Expand Down
2 changes: 1 addition & 1 deletion src/loadgenerator/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: loadgenerator
description: The load generator is based on the Python load testing framework Locust. By default it will simulate users requesting several different routes from the frontend.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/loadgenerator
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/otelcollector/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: otelcollector
description: The OpenTelemetry Collector offers a vendor-agnostic implementation of how to receive, process and export telemetry data.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/otelcollector
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/paymentservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: paymentservice
description: This service is responsible to process credit card payments for orders. It will return an error if the credit card is invalid or the payment can not be processed.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/payment
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/productcatalogservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: productcatalogservice
description: This service is responsible to return information about products. The service can be used to get all products, search for specific products, or return details about any single product.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/productcatalog
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/prometheus/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: prometheus
description: All generated metrics and exemplars are scraped by Prometheus.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/prometheus
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/quoteservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: quoteservice
description: This service is responsible for calculating shipping costs, based on the number of items to be shipped. The quote service is called from Shipping Service via HTTP.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/quote
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/recommendationservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: recommendationservice
description: This service is responsible to get a list of recommended products for the user based on existing product IDs the user is browsing.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/recommendation
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down
2 changes: 1 addition & 1 deletion src/shippingservice/backstage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
name: shippingservice
description: This service is responsible for providing shipping information including pricing and tracking information, when requested from Checkout Service.
annotations:
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/
backstage.io/techdocs-ref: url:https://github.com/jmichalak9/opentelemetry.io/tree/main/content/en/docs/demo/services/shipping
github.com/project-slug: jmichalak9/opentelemetry-demo
spec:
type: service
Expand Down

0 comments on commit d21a491

Please sign in to comment.