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

Demo Architecture Diagram shows "unsupported markdown" #5168

Closed
candlerb opened this issue Sep 9, 2024 · 6 comments · Fixed by #5175
Closed

Demo Architecture Diagram shows "unsupported markdown" #5168

candlerb opened this issue Sep 9, 2024 · 6 comments · Fixed by #5175
Labels
bug Something isn't working sig:demo

Comments

@candlerb
Copy link

candlerb commented Sep 9, 2024

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
Copy link
Member

svrnm commented Sep 9, 2024

@open-telemetry/demo-approvers PTAL>

@candlerb thanks for reporting

@svrnm svrnm changed the title Page feedback Demo Architecture Diagram shows "unsupported markdown" Sep 9, 2024
@julianocosta89
Copy link
Member

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

@theletterf
Copy link
Member

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
Copy link
Author

There's this recent bug: mermaid-js/mermaid#5824

@theletterf
Copy link
Member

@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
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working sig:demo
Projects
Status: Done
4 participants