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

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

Merged
merged 2 commits into from
Nov 16, 2024

Conversation

chris48s
Copy link
Member

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.

@chris48s chris48s added documentation Developer and end-user documentation blog post labels Nov 15, 2024
Copy link
Contributor

github-actions bot commented Nov 15, 2024

Messages
📖 ✨ Thanks for your contribution to Shields, @chris48s!
📖

Thanks for contributing to our documentation. We ❤️ our documentarians!

Generated by 🚫 dangerJS against b4dbbac

Copy link
Contributor

@jNullj jNullj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, liked the idea to give a short description then link to a blog post with the full details.

@chris48s chris48s added this pull request to the merge queue Nov 16, 2024
Merged via the queue into badges:master with commit 4132ca2 Nov 16, 2024
23 checks passed
@chris48s chris48s deleted the token-pool-cta branch November 16, 2024 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blog post documentation Developer and end-user documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants