search

badges / shields

Concise, consistent, and legible badges in SVG and raster format
https://shields.io
Creative Commons Zero v1.0 Universal
23.9k stars 5.51k forks source link

Add blog post about token pool, improve 'authorise our app' CTA #10683

Closed chris48s closed 1 week ago

chris48s commented 1 week ago

Every documentation page for a GitHub badge has a call to action on it that says:

If your GitHub badge errors, it might be because you hit GitHub's rate limits. You can increase Shields.io's rate limit by adding the Shields GitHub application using your GitHub account.

That sentence has been around for a very long time, and lots of people have authorised the app. However, I don't think it is very good for two reasons:

  1. It doesn't really explain how this works, exactly what you're sharing with us or how to opt out later.
  2. It doesn't really reflect the current reality. Today we have plenty of tokens. If you're seeing an error it almost definitely isn't going to be solved by authorising the app.

So in this PR I am attempting to write up a better explanation of what this is and how it works that is more up-to-date and more transparent for users.

github-actions[bot] commented 1 week ago
Messages
:book: :sparkles: Thanks for your contribution to Shields, @chris48s!
:book: Thanks for contributing to our documentation. We :heart: our [documentarians](http://www.writethedocs.org/)!

Generated by :no_entry_sign: dangerJS against b4dbbac0b714441e76b5eb2568855d64290f9660