search

mumble-voip / mumble-www

The Mumble website
https://www.mumble.info
Other
12 stars 17 forks source link

FR: Add feature requests page #171

Closed Kissaki closed 2 years ago

Kissaki commented 2 years ago

Adds a feature request page that queries the GitHub Search API for our feature requests (anonymous request subject to rate limiting) and renders them as an ordered list.

The Search API has a custom rate limit. For requests using Basic Authentication, OAuth, or client ID and secret, you can make up to 30 requests per minute. For unauthenticated requests, the rate limit allows you to make up to 10 requests per minute.

Updates the contribute page to refer to it as well as the support label which was not mentioned before.

image

Fixes #156

Kissaki commented 2 years ago

@Krzmbrzl When creating #156 did you have any reference like a menu item or placement in mind?

For now, I referred to it and extended the Contribute issues section with it and also mentioning the support label tickets.

Kissaki commented 2 years ago

@davidebeatrici if you also want to take a look

Krzmbrzl commented 2 years ago

Awesome! The only thing I think could be improved is the style of the list as I have the feeling that e.g. the font used for the list doesn't fit in the rest of the pages on our website. But as far as I can tell you didn't specifically choose a different font for the list, did you? Also I am wondering, whether underlining the different entries is really necessary? To me it seems to be too much, since every item is underlined…

anonymous request subject to rate limiting

Does that mean that only a fixed amount of people may open this viewer on our website every n minutes? But I guess given the actual limitations set by GitHub, this shouldn't cause us too much trouble. Did you add a message for users that might experience this corner-case though? It might be good to know for them that they only have to wait a minute before trying again.

When creating #156 did you have any reference like a menu item or placement in mind?

I did not - but thinking about this now, I guess that featuring such a great feature somewhere visible might be a good thing. Maybe even next to the Downloads button on the front page?

Kissaki commented 2 years ago

The rate limiting is IP based. So every visitor has 10 equests per minute. Should not be an issue.

This is also why I chose the Search API too, instead of GitHub API, which has much lower rates for anonymous requests.

I assume the return status code will not be 200, so it will go into the loading failure state with notice and link to the feature tracker.

Kissaki commented 2 years ago

Yeah, I noticed the font. Now I think it's probably because it is outside of the markdown content block and that's why the default font is different. I will adjust it.

A sidebar with top issues may be interesting. That extends our current page layouts though, so I'd do that in a later step after this.

Caching the results in browser session storage may also be viable to reduce requests to GitHub and prevent rate limit issues. I'd do that later rather than right now too though.