-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
--- | ||
|
||
{{% 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 %}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 %}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 %}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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: