diff --git a/content/en/community/demo/_index.md b/content/en/community/demo/_index.md index 7d248fda79be..b696d419024a 100644 --- a/content/en/community/demo/_index.md +++ b/content/en/community/demo/_index.md @@ -1,12 +1,8 @@ --- title: OpenTelemetry Demo linkTitle: Demo +description: + The OpenTelemetry Demo is a microservice-based distributed system intended to illustrate the implementation of OpenTelemetry in a near real-world environment. --- -{{% alert title="Important" color="warning" %}} The demo is a work in progress. If -you'd like to help, check out our -[contributing guidance](https://github.com/open-telemetry/opentelemetry-demo#contributing). -{{% /alert %}} - -Get a first impression of observability with OpenTelemetry with the -[official OpenTelemetry Demo](https://github.com/open-telemetry/opentelemetry-demo). +{{% demo_description %}} diff --git a/content/en/docs/getting-started/demo.md b/content/en/docs/getting-started/demo.md new file mode 100644 index 000000000000..9c914cf46713 --- /dev/null +++ b/content/en/docs/getting-started/demo.md @@ -0,0 +1,9 @@ +--- +title: OpenTelemetry Demo +linkTitle: Demo +description: + The OpenTelemetry Demo is a microservice-based distributed system intended to illustrate the implementation of OpenTelemetry in a near real-world environment. +weight: 5 +--- + +{{% demo_description %}} \ No newline at end of file diff --git a/content/en/docs/opentelemetry-demo/_index.md b/content/en/docs/opentelemetry-demo/_index.md new file mode 100644 index 000000000000..a190236455ed --- /dev/null +++ b/content/en/docs/opentelemetry-demo/_index.md @@ -0,0 +1,10 @@ +--- +title: OpenTelemetry Demo +linkTitle: OpenTelemetry Demo +weight: 12 +description: + The OpenTelemetry Demo is a microservice-based distributed system intended to illustrate the implementation of OpenTelemetry in a near real-world environment. +aliases: [/docs/demo] +--- + +{{% demo_description %}} \ No newline at end of file diff --git a/layouts/shortcodes/demo_description.md b/layouts/shortcodes/demo_description.md new file mode 100644 index 000000000000..435d21eff463 --- /dev/null +++ b/layouts/shortcodes/demo_description.md @@ -0,0 +1,21 @@ +The [OpenTelemetry Demo](https://github.com/open-telemetry/opentelemetry-demo) +does the following: + +* Provides a realistic example of a distributed system that can be used to + demonstrate OpenTelemetry instrumentation and observability. +* Builds a base for vendors, tooling authors, and others to extend and + demonstrate their OpenTelemetry integrations. +* Creates a living example for OpenTelemetry contributors to use for testing new + versions of the API, SDK, and other components or enhancements. + +If you find yourself asking questions like: + +* How should I use the SDK for my language? +* What's the best way to use OpenTelemetry APIs? +* How should my services be configured? +* How should my OpenTelemetry Collector be configured? +* How do I consider the + [architecture](https://github.com/open-telemetry/opentelemetry-demo/blob/main/docs/current_architecture.md) + of a system using OpenTelemetry? + +Then check out the [Demo](https://github.com/open-telemetry/opentelemetry-demo). \ No newline at end of file