search

open-telemetry / opentelemetry.io

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

config_option shortcode is escaping HTML #2489

Open chalin opened 1 year ago

chalin commented 1 year ago

Visit https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/#peer-service-name and you'll see:

Screen Shot 2023-03-12 at 20 17 37

It seems that Hugo's trim function is escaping HTML.

shyamtawli commented 1 year ago

Hey can I work on it.

chalin commented 1 year ago

@svrnm - FYI, I'm going to remove the "good first issue" because I think this one is hitting a Hugo bug, and so it will likely require good knowledge of Hugo to investigate and resolve.

svrnm commented 1 year ago

Thanks @chalin, my assumption was this is a quick fix by editing the file.

@shyamtawli apologies see chalin's comment above, this is not a good starter issue

chalin commented 1 year ago

No worries! It does look like a quick-fix candidate.

shyamtawli commented 1 year ago

No Issue @svrnm I will see other beginner issues.

chalin commented 1 year ago

Thanks! For the record, it seems likely that Go templates are escaping based on context, similar to what happened in #2509, which was resolved via:

It's not clear to me why this is happening for a shortcode rendered as markdown.