open-telemetry / opentelemetry.io

The OpenTelemetry website and documentation
https://opentelemetry.io
Creative Commons Attribution 4.0 International
543 stars 1.2k forks source link

Demo Architecture Diagram shows "unsupported markdown" #5168

Closed candlerb closed 2 months ago

candlerb commented 2 months ago

Suggested improvements for page: https://opentelemetry.io/docs/demo/architecture/

There is a rendering problem in the images, where there are currently lots of URLs shown as "Unsupported markdown: link" - both inside nodes and on edges. This makes the images hard to interpret.

Examples:

image

The text inside the graph source is much clearer, e.g.

            pr-http[/"Prometheus HTTP<br/>listening on<br/>http://localhost:9090"/]
svrnm commented 2 months ago

@open-telemetry/demo-approvers PTAL>

@candlerb thanks for reporting

julianocosta89 commented 2 months ago

@svrnm has anything changed in the docs? I'm pretty sure this was working before 🤔

theletterf commented 2 months ago

This doesn't work in the Mermaid live editor either. Example.

There seems to be an issue with Mermaid: https://github.com/orgs/community/discussions/106690#discussioncomment-8698490

I couldn't find any bug in Mermaid's repo about this, though. As Mermaid is working as intended, I'll open a PR to sanitize the links by removing "http://"

candlerb commented 2 months ago

There's this recent bug: https://github.com/mermaid-js/mermaid/issues/5824

theletterf commented 2 months ago

@candlerb Good find! Seems critical enough to get fixed soon.

@svrnm We'd either wait or pin Mermaid to a previous version. Not sure when that regression was introduced, though.

theletterf commented 2 months ago

I've patched the diagram, but let's follow up on that Mermaid bug.