awesome-global-contributions / awesome-global-contributions.github.io

The website for the awesome-global-contributions list
https://awesome-global-contributions.github.io
MIT License
0 stars 0 forks source link

Define Filters #2

Open OscarAblinger opened 4 years ago

OscarAblinger commented 4 years ago

The website should be able to filter projects based on their characteristics. Some are pretty clear that they should exist, but others might have to be discussed further. This is a current list of which filters are planned. If you've other ideas or comments please feel free to answer to this.

Currently planned filters:

And no filter for:

AdrienLemaire commented 4 years ago

Name might better fit as a search field than as a filter field.

SDGs (since they are already ordered by that. Even less useful once ToC is implemented)

Filtering ≠ Sorting. We haven't reached a critical mass of data, so it doesn't matter at the moment, but it might eventually become useful.

"stars" and "Number of contributors" look like good sorting fields. Some e-commerces also use them as filter, but again, I believe it depends on the data volume. The less data we have, the less searching/sorting/filtering matter.

OscarAblinger commented 4 years ago

Name might better fit as a search field than as a filter field.

I'm not sure what the difference is between those two ^^

Filtering ≠ Sorting. We haven't reached a critical mass of data, so it doesn't matter at the moment, but it might eventually become useful.

That is true, and it would also allow to filter for multiple SDGs. I'll look into it more…

"stars" and "Number of contributors" look like good sorting fields.

Theoretically yes, but we currently have no way to query stars. I think, we should probably re-work them anyways. The shield.io link is nice, but if we want the actual numbers, we'd need some way to check them. Maybe there's a library that allows querying for common statistics across hosting platforms like Github, Gitlab, Gittea etc. – then we could use that and most likely not need the complicated form we currently have for Number of contributors

AdrienLemaire commented 4 years ago

Name might better fit as a search field than as a filter field.

I'm not sure what the difference is between those two ^^

Search fields are fields that are being queried when typing text in a free input field. Filter fields are usually represented by select dropdown lists or radio checkbox.

If you want a number for stars instead of urls, I can query/parse that information from the yaml2markdown.sh script and add a specific field in the dist json file. I'd prefer our tools to have well-defined responsibilities, and you'll surely agree that the website's responsibility is to nicely present the json content (it's just an alternative to the README page). It shouldn't need to go and fetch new data independently (which could eventually create data inconsistency). With the json file as the "single source of truth", the json generator is the more apt to take care of adding new data to it :)