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

Fix flowchart syntax #6454

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

lehmannro
Copy link

The Mermaid chart under Discovery currently renders with an error:

Unsupported markdown: list

Quotation marks are used to escape characters that break Mermaid's own syntax. For Markdown escaping, entity codes have to be used.

The Mermaid chart under *Discovery* currently renders with an error:
```
Unsupported markdown: list
```

Quotation marks are used to escape [characters that break Mermaid's own syntax](https://mermaid.js.org/syntax/flowchart.html#special-characters-that-break-syntax).  For Markdown escaping, [entity codes](https://mermaid.js.org/syntax/flowchart.html#entity-codes-to-escape-characters) have to be used.
@lehmannro lehmannro requested a review from a team as a code owner March 2, 2025 22:14
Copy link

linux-foundation-easycla bot commented Mar 2, 2025

CLA Signed


The committers listed above are authorized under a signed CLA.

@opentelemetrybot opentelemetrybot requested a review from a team March 2, 2025 22:14
@github-actions github-actions bot added the blog label Mar 2, 2025
@lehmannro
Copy link
Author

Looks better: https://deploy-preview-6454--opentelemetry.netlify.app/blog/2024/prom-and-otel/#discovery-of-prometheus-custom-resources

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for submitting a fix @lehmannro 🙌🏻

Let's switch to using a simple escape character rather than using entity codes. For an example of how we did this before, see https://github.com/open-telemetry/opentelemetry.io/pull/6253/files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants