search

CodingTrain / thecodingtrain.com

All aboard the Coding Train! Choo choo! 🚂🌈❤️
https://thecodingtrain.com
MIT License
189 stars 107 forks source link

Missing thumbnail images for (older) showcase contributions #1057

Closed fturmel closed 4 months ago

fturmel commented 1 year ago

99 out of 1398 (~14%) showcase contributions do not have an accompanying image. Just dumping this here in case someone wants to take screenshots and help close this gap.

It's not breaking the site, but we are displaying a placeholder that doesn't give information about the featured work so it would be a nice low priority improvement. Low-hanging fruit for first-time GitHub contributions maybe?

Screenshot 2023-05-15 at 1 20 57 PM

Reminder on the image specs (from the contribution guide):

While any aspect ratio is fine (the site will resize and crop as necessary), the images will be displayed at 16:9 aspect ratio. We suggest you upload a "landscape" image. The file format should be JPG or PNG, with a maximum width of 800px and file size of 500 kb. Name your thumbnail image with the same filename as your showcase submission (contribution1.png, contribution2.jpg, etc.).

And the list:

shiffman commented 1 year ago

Wow, thanks for making this list! I'll also note that the passenger showcase image pulls from the video's index.jpg if it has one. For example, if you look at the showcase projects missing a thumbnail for the Marching Squares challenge you'll see the example image applied.

Screen Shot 2023-05-15 at 2 31 23 PM

We never made placeholder thumbs for videos associated with tracks (not challenges) but that might be worth considering as well, possibly even building it in as a requirement for tests to pass (though we'd have to fill in all the missing ones first.)

kfahn22 commented 1 year ago

Some of the showcases were ports to a different language which made it more time-consuming to grab the image (a consideration when you are adding a ton of them). I have just added a couple of images for marching squares (one isn't loading--not sure if it is just me) and hillbert curve and also deleted two that get 404s now. Noting that this is another issue--some showcases that were added are no longer available. When I run across them I delete, but can a more systematic way of dealing with them be implemented?

fturmel commented 1 year ago

can a more systematic way of dealing with them be implemented?

Definitely yes. I did write some code a while back that grabbed any URL from the site and verified that it was still working, which lead to #966. I had planned to run it against the contributions eventually, and share it as an audit tool in the ./node-scripts for everyone to use.

Lots of work this week, but maybe I can do this over the weekend. I'll tag you on the PR.

shiffman commented 4 months ago

I'm doing a pass over all the issues today, is this one still relevant should we work on updating thumbs for more old showcase project or are we covered enough now?

kfahn22 commented 4 months ago

There are still a lot of showcases that were ported from old site that do not have images. I think the ones that were relatively easy to grab are done and the ones that are left are more time-consuming / harder (different languages or platforms) to obtain. It is a judgement call about whether to close.

shiffman commented 4 months ago

I am going to close this issue, it is not a priority for me to do a mass update of these and individual ones can be added as needed if the original contributor or any volunteers want to!