opentelemetry.io icon indicating copy to clipboard operation
opentelemetry.io copied to clipboard
verified publisher icon open-telemetry

OTel intro rework

Open chalin opened this issue 9 months ago • 7 comments

  • [x] Copyedit "What is OTel" - #6487
  • [x] #6550
    • [x] #6474
    • [x] Also add links to training in What next / Learn more
  • [ ] I think that we should move the "What next" list from "What is OTel" to the main docs landing page, and edit front page "Learn more" button to point to the Docs landing page, move the video etc.

Extra(?):

  • [x] Fix the main diagram in https://opentelemetry.io/docs/ (maybe). For details, see comment below.

chalin avatar Mar 06 '25 21:03 chalin

@open-telemetry/docs-approvers @LisaHJung @open-telemetry/sig-end-user-approvers - shouldn't "Frontends" in the right-most block of the following diagram be "Backends"?

Btw, this is from https://opentelemetry.io/docs/.

chalin avatar Mar 06 '25 22:03 chalin

I assume you mean "shouldn't "Frontends" in the right-most block of the following diagram be "Backends"?". I agree. I think the word "frontend" here was probably used to refer to their UI/alerting layer, but we name them "backends" everywhere else.

danielgblanco avatar Mar 18 '25 10:03 danielgblanco

Oops, yes, I meant "right-most". Fixed, thanks! 😅

chalin avatar Mar 18 '25 14:03 chalin

Regarding the diagram, should the arrows from "OTel Collector" to "Observability Frontends & APIs" be right-arrows instead of being double-ended?

cc @jade-guiton-dd who spotted this on the slides from one of the talks I gave at last KubeCon

mx-psi avatar Apr 14 '25 10:04 mx-psi

@austinlparker @svrnm - we need an editable version of that diagram. The current SVG draws each character, and so isn't editable. Can we get someone to draw a new diagram 😄 ? Any ideas ?

chalin avatar Apr 28 '25 23:04 chalin

should the arrows from "OTel Collector" to "Observability Frontends & APIs" be right-arrows instead of being double-ended?

The reasoning of that may have been a pull model where backends pull from the collector... but I agree, this is not a dependency diagram and more of a data flow diagram, where we're interesting in the flow of data from one place to the next.

danielgblanco avatar May 22 '25 16:05 danielgblanco

I think that we should move the "What next" list from "What is OTel" to the main docs landing page, and edit front page "Learn more" button to point to the Docs landing page, move the video etc.

Let's look into that again

svrnm avatar Nov 24 '25 07:11 svrnm