Skip to content

README badges fail to render #2805

Closed
@piskvorky

Description

I see this often in many Github repos (not just Gensim):

Screen Shot 2020-04-23 at 15 35 54

According to badges/shields#1568, this is an issue with Github's non-caching proxy (https://camo.githubusercontent.com) timing out when querying the original image (hosted at https://img.shields.io).

The proxy timeout limit seems to be 4 seconds. So if img.shields.io takes longer than 4 seconds to return the image, Github will show a broken image instead.

Github injects its proxy automatically to all <img> links and I found no way to disable it.

A solution suggested here is to use another proxy, one that caches the img.shields.io response so that github's proxy doesn't time out. For example Google's caching proxy at https://images1-focus-opensocial.googleusercontent.com/gadgets/proxy.

Example of a cached "shields => google's cache => github's proxy => browser" badge:
https://images1-focus-opensocial.googleusercontent.com/gadgets/proxy?container=focus&refresh=3600&url=https%3A%2F%2Fimg.shields.io%2Fpypi%2Fdm%2Fgensim%3Fcolor%3Dblue example

Metadata

Assignees

No one assigned

    Labels

    bugIssue described a bugdocumentationCurrent issue related to documentationimpact LOWLow impact on affected usersreach LOWAffects only niche use-case users

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions