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

Remove markup (like images) from page descriptions #680

Open
chalin opened this issue Aug 16, 2021 · 5 comments
Open

Remove markup (like images) from page descriptions #680

chalin opened this issue Aug 16, 2021 · 5 comments
Labels
bug Something isn't working cleanup/refactoring e1-hours Effort: < 8 hrs help wanted Extra attention is needed p2-medium

Comments

@chalin
Copy link
Contributor

chalin commented Aug 16, 2021

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 chalin added bug Something isn't working cleanup/refactoring labels Aug 16, 2021
@chalin
Copy link
Contributor Author

chalin commented Aug 16, 2021

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.

@austinlparker
Copy link
Member

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?

@chalin
Copy link
Contributor Author

chalin commented Sep 15, 2021

... 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 chalin mentioned this issue Sep 23, 2021
32 tasks
@chalin chalin added e1-hours Effort: < 8 hrs p2-medium labels Oct 22, 2021
@svrnm svrnm added the help wanted Extra attention is needed label Aug 30, 2022
@chalin
Copy link
Contributor Author

chalin commented Feb 20, 2023

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

@theletterf
Copy link
Member

How can we help here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working cleanup/refactoring e1-hours Effort: < 8 hrs help wanted Extra attention is needed p2-medium
Projects
None yet
Development

No branches or pull requests

4 participants