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

Discovery of Prometheus Custom Resources Diagram shows "Unsupported markdown: list" #3621

Open
CharlieTLe opened this issue Jan 18, 2025 · 0 comments
Labels
bug Something isn't working needs triage

Comments

@CharlieTLe
Copy link

CharlieTLe commented Jan 18, 2025

Component(s)

target allocator

What happened?

The flowchart diagram in the "Discovery of Prometheus Custom Resources" section of the Target Allocator's README is showing an error for the labels that should be under the edges between nodes.

See image below for how it is currently rendered on Github.

Image

The problematic text is on

sm ~~~|"1. Discover Prometheus Operator CRs"| sm
ta ~~~|"2. Add job to TA scrape configuration"| ta
oc3 ~~~|"3. Add job to OTel Collector scrape configuration"| oc3

This seems to render fine in the Markdown Preview window of my IDE (Jetbrains). I've attached an image of what it looks like locally in my IDE below.

Image

Removing the numbers seems to get it to render without the error, but even then, the edge labels aren't directly beneath the edges it's meant to label.

Image

The edge type is an invisible link with text.

If we make the link visible, we can see why it is off to the side.

  sm ---|"Discover Prometheus Operator CRs"| sm
  ta ---|"Add job to TA scrape configuration"| ta
  oc3 ---|"Add job to OTel Collector scrape configuration"| oc3

See diagram below for visible link.

Image

Kubernetes Version

n/a

Operator version

n/a

Collector version

n/a

Environment information

No response

Log output

Additional context

No response

@CharlieTLe CharlieTLe added bug Something isn't working needs triage labels Jan 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working needs triage
Projects
None yet
Development

No branches or pull requests

1 participant