Image error control

[shawshankkumar]

Have you read the Contributing Guidelines on issues?

• I have read the Contributing Guidelines on issues.

Motivation

Greetings,

I am not 100% sure if this should be in the proposal part or the bug part but I chose to use the proposal issue because the thing I am going to write about is not exactly a bug, it is expected, I just think it can be handled in a better way.

So when you go to https://docusaurus.io/ and go to the Loved by many engineers part, tweets come up(The code has a component and it is mapped over by the data). I believe some twitter images are breaking for example this screenshot:

Mael and Kent's pictures' URL is broken and hence the img tag shows the alt name. I believe it would be much better if it showed a default avatar instead. This can be done in a few easy steps and I am willing (and excited) to work on this.

What are my next steps? I am open to suggestions!

Thanks.

Self-service

• I'd be willing to do some initial work on this proposal myself.

[shawshankkumar]

This is something I tried. The default image is ofcourse subject to change but this is what it would look like. Instead of an alt text, an default avatar if the image from twitter doesn't work.

[slorber]

Yes that Twitter thing is a pain, as their image urls changes and they do not make it easy at all to get the image URL from an avatar (unlike GitHub

What I suggest we do instead:

• add a githubUsername prop: all users on that list should have a GitHub account and the URL always work: https://github.io/slorber.png
• read twitterUsername from the tweet URL prop, and use unavatar.io
• Image URL = https://unavatar.io/twitter/<twitterUsername>?fallback=https://github.com/<githubUsername>.png
• Example: https://unavatar.io/twitter/sebastienlorber?fallback=https://github.com/slorber.png

We need the unavatar fallback because in my experience it's not 100% reliable, may fail to fetch the real twitter avatar and often display the default fallback

Do you want to work on this?

[abhinandanwadwa]

Hey @slorber , I'd like to work on this issue!

[shawshankkumar]

Yes that Twitter thing is a pain, as their image urls changes and they do not make it easy at all to get the image URL from an avatar (unlike GitHub

What I suggest we do instead:

• add a githubUsername prop: all users on that list should have a GitHub account and the URL always work: https://github.io/slorber.png
• read twitterUsername from the tweet URL prop, and use unavatar.io
• Image URL = https://unavatar.io/twitter/<twitterUsername>?fallback=https://github.com/<githubUsername>.png
• Example: https://unavatar.io/twitter/sebastienlorber?fallback=https://github.com/slorber.png

We need the unavatar fallback because in my experience it's not 100% reliable, may fail to fetch the real twitter avatar and often display the default fallback

Do you want to work on this?

Yes sure. I'd love on work this. I'll make a pr as soon as possible?

[abhinandanwadwa]

@slorber I've created a PR for the issue!

[shawshankkumar]

@slorber I've created a PR for the issue!

Hey @abhinandanwadwa since i initiated this, i would like to fix this and make a pr. Please follow the same process from the next time. @slorber I'll be making a pr soon, hope that's fine.

[slorber]

@shawshankkumar sorry but our policy is that if you want to claim an issue you have to submit a draft PR first

This is to prevent people from saying that they will work on something, and then they ghost us and nobody works on the issue due to the issue being claimed, which happened a lot in the past.

This also saves maintainer time.

If you want to claim an issue, you have to demonstrate you really plan to work on it fast otherwise someone else will

[shawshankkumar]

@shawshankkumar sorry but our policy is that if you want to claim an issue you have to submit a draft PR first

This is to prevent people from saying that they will work on something, and then they ghost us and nobody works on the issue due to the issue being claimed, which happened a lot in the past.

This also saves maintainer time.

If you want to claim an issue, you have to demonstrate you really plan to work on it fast otherwise someone else will

Oh Okay. i had the code ready for the first one and was working on the second. That suck 😞 But no worries. Thanks for your time.

[slorber]

sorry about that

the best way to contribute small issues such as this one is to directly open a PR with a fix proposal, demonstrating your intention to work on it. From there I can review your PR and suggest a possible better alternative if your approach is not good enough

[shawshankkumar]

That sounds great. I'll look for more!

…

On Thu, Dec 15, 2022 at 5:21 PM Sébastien Lorber ***@***.***> wrote: sorry about that the best way to contribute small issues such as this one is to directly open a PR with a fix proposal, demonstrating your intention to work on it. From there I can review your PR and suggest a possible better alternative if your approach is not good enough — Reply to this email directly, view it on GitHub <#8436 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AR22P3PVVOGO644XETD5ZTDWNMA35ANCNFSM6AAAAAAS44MWLA> . You are receiving this because you were mentioned.Message ID: ***@***.***>