Sprinkle some more demo on the docs #2139
Conversation
|
Lgtm in general. One nit is to bold the demo title in the TOC like the other items. Ex. K8s operator. Thanks for doing this! |
|
Fixed! |
| @@ -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. | |||
There was a problem hiding this comment.
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.
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.
We can follow up on this, @chalin might have a suggestion/solution for this?
There was a problem hiding this comment.
Hi. The fact that this duplication exists is a bad smell IMHO. For a suggested alternative way of achieving this, see:
|
I like it! Eventually I think we should remove one of the Demo links in the docs (either we have it beyond "Getting Started" or as top level item), but maybe we can track which one is used more and then later drop the other one? |
|
Yep, we can track via GA I believe. |
|
I would hesitate to contribute the full increase to the docs change as the new year really starts but there seems to be a noticeable increase in demo repo traffic from the website which is great to see.
|
fixes #2137
There's several ways to skin this cat I guess, but I went with a shortcode shared across a few pages.
Preview: https://deploy-preview-2139--opentelemetry.netlify.app/docs/