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

Banner: API Rate Limit #551

Closed
elenananana opened this issue Oct 25, 2023 · 7 comments
Closed

Banner: API Rate Limit #551

elenananana opened this issue Oct 25, 2023 · 7 comments
Assignees

Comments

@elenananana
Copy link
Contributor

elenananana commented Oct 25, 2023

as part of comms for a new API rate limit, I'd like to put a banner up on docs. Ideally the banner goes up once the blog is out, but it can go up anytime if there are other pressing priorities.

@Ginny /-/ has this banner preset for announcements/warning, we'd only need to swap colors and icon

Copy: Upcoming changes to rate limits for Hiro APIs → Learn more.

https://www.figma.com/file/Gc7LJh8NWRvSOWQMnxmCm5/Hiro-Docs-2023?type=design&node-id=621%3A128&mode=design&t=zuxgF0HQ6JBj9UaB-1

@sabbyanandan @eugeniadigon

@saralab
Copy link
Contributor

saralab commented Oct 25, 2023

@ryanwaits Let's split this issue into 2 :

  1. The API rate limit banner which should be good to go as is now
  2. A Warning banner as shown in the designs : This will involve some integration with Status Page and we need to ensure that the banner can auto-update or close when the Issues/Warning is resolved.

@ginny-d
Copy link

ginny-d commented Oct 25, 2023

@saralab Please refer only to the board shared for this specific task (https://www.figma.com/file/Gc7LJh8NWRvSOWQMnxmCm5/Hiro-Docs-2023?type=design&node-id=621%3A128&mode=design&t=zuxgF0HQ6JBj9UaB-1)

The other Figma board (warning banner) was a previous design made as an example, not meant to be implemented right now. That being said, if there's capacity to implement this as well, that's good!

@ryanwaits
Copy link
Collaborator

based on how the current banner works, we should be able to put up a new one once the blog is posted. it's a hard coded time window so if we have an expected release date of the the rate limit blog + how long we'd like to have the banner exposed, all i'd need are the dates and the expected url for the blog and we should be good to go

@ryanwaits
Copy link
Collaborator

@ryanwaits Let's split this issue into 2 :

  1. The API rate limit banner which should be good to go as is now
  2. A Warning banner as shown in the designs : This will involve some integration with Status Page and we need to ensure that the banner can auto-update or close when the Issues/Warning is resolved.

@saralab #553

@sabbyanandan
Copy link
Contributor

Aside from the Banner or however else y'all are thinking about solving this, please also ensure all the three rate-limiting guides are updated to include the supported RPM with and without API Key.

@saralab
Copy link
Contributor

saralab commented Oct 27, 2023

The other Figma board (warning banner) was a previous design made as an example, not meant to be implemented right >now. That being said, if there's capacity to implement this as well, that's good!

I understand that, the ask to create an issue is so we can track that change even if we don't have the bandwidth at the moment.

@ryanwaits
Copy link
Collaborator

closing: moved additional issues to separate tickets #553 and #557

@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in Hiro Docs Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

No branches or pull requests

5 participants