Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sprinkle some more demo on the docs #2139

Merged
merged 4 commits into from
Jan 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions content/en/community/demo/_index.md
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This same sentence is needed in 3 places. I don't know the docs structure, but I'm thinking if there's a way to have it only in one place and include it from there. It would be easier when changes are needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not aware of how to template these descriptions. I'm happy to also move it and bring it down into the text itself, but this also removes the description from google search results.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can follow up on this, @chalin might have a suggestion/solution for this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi. The fact that this duplication exists is a bad smell IMHO. For a suggested alternative way of achieving this, see:

---

{{% 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 %}}
9 changes: 9 additions & 0 deletions content/en/docs/getting-started/demo.md
Original file line number Diff line number Diff line change
@@ -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 %}}
10 changes: 10 additions & 0 deletions content/en/docs/opentelemetry-demo/_index.md
Original file line number Diff line number Diff line change
@@ -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 %}}
21 changes: 21 additions & 0 deletions layouts/shortcodes/demo_description.md
Original file line number Diff line number Diff line change
@@ -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).