opentelemetry.io icon indicating copy to clipboard operation
opentelemetry.io copied to clipboard

Remove markup (like images) from page descriptions

Open chalin opened this issue 4 years ago • 3 comments

For example, page description for the Java landing page contains an image; here's the relevant excerpt from the front matter of https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/docs/java/_index.md (whose canonical source is https://github.com/open-telemetry/opentelemetry-java/blob/main/website_docs/_index.md):

description: >
  <img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Java_SDK.svg"></img>
  A language-specific implementation of OpenTelemetry in Java.

While this looks nice in the website page, it causes problems for social media, etc. that expect a plaintext description. This is what the description would look like if you posted to social media:

<img width=&#34;35&#34; src=&#34;https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Java_SDK.svg&#34;></img> A language-specific implementation of OpenTelemetry in Java.

chalin avatar Aug 16 '21 20:08 chalin

I see that the icons were added via #399 (for example). There are a couple of ways that we can address this so as to preserve the current page display, while fixing social media post descriptions. Let's discuss when you're back @austinlparker, or whoever else would like to share an opinion.

chalin avatar Aug 16 '21 23:08 chalin

What's the best fix here, you think? Editing the template so that we can include the icon as a separate Hugo resource and have it inserted that way?

austinlparker avatar Sep 13 '21 13:09 austinlparker

... template so that we can include the icon as a separate Hugo resource and have it inserted that way

Yes, something like that would do.

chalin avatar Sep 15 '21 14:09 chalin

I might be able to address this via styling. I'll investigate as soon as I can.

chalin avatar Feb 20 '23 19:02 chalin

How can we help here?

theletterf avatar Apr 09 '24 09:04 theletterf