tauri-docs icon indicating copy to clipboard operation
tauri-docs copied to clipboard

Draft: GitHub Sponsors and Open Collective contribution graph

Open lorenzolewis opened this issue 2 years ago • 4 comments

What kind of changes does this PR include?

  • Changes to the docs site code

Description

This is a draft POC to demo out pulling in GitHub sponsors and Open Collective contributions to highlight the awesome people who sponsor Tauri!

Expecting the build to fail due to env vars not being set up.

lorenzolewis avatar Oct 26 '23 11:10 lorenzolewis

Deploy Preview for tauri-docs-starlight failed.

Name Link
Latest commit d752f9f23daa31136163d243b427ad1d96dd0c1c
Latest deploy log https://app.netlify.com/sites/tauri-docs-starlight/deploys/65e3aa754cfac5000846c4d6

netlify[bot] avatar Oct 26 '23 11:10 netlify[bot]

@lorenzolewis I want to continue this. Could you brief me about what you were envisioning?

vasfvitor avatar Mar 02 '24 23:03 vasfvitor

Sure thing @vasfvitor ! I'm not sure if there have been any discussion around sponsorship in general in the last few WG calls as I haven't been in them, so take all of this below with a grain of salt:


The idea was to surface all people who sponsor (via Open Collective or GitHub Sponsors) and not just the ones who reach out to put their logo on the site. This way we can be more inclusive, fair, and also automate this more if we ping the respective APIs.

Open Collective

For Open Collective you're able to see the total over time an entity (person or company) has contributed. The results would be sorted based on that. There are a few different ideas of how to organise this:

  1. Based on different "tiers" (gold, platinum, silver, etc.) with pre-defined amounts for each
  2. Sorted based on total historical contributions

I was mocking these out in this PR to show WG and get an idea of what is preferred, so that would need to be discussed I imagine.

GitHub Sponsors

For GitHub Sponsors we aren't able to see how much a certain person donates, so we would show them all (yes, it is possible to do that with an access token with the correct permissions, but this should only be using publicly available data to avoid exposing sensitive information).

Note that you will need an access key to query the GitHub GraphQL API (even for public data), so just make sure that is set up appropriately.

I would place all GitHub Sponsors below the Open Collective sponsors since we're not able to determine the amount donated.

Non-Monetary Donations

Some companies donate to us via a service (service provider like Netlify). I would put those into their own separate section/heading outside of the purely financial donations.

Astro does so in this way on their index page:

Screenshot 2024-03-03 at 12 43 54

I feel trying to sift them into different "tiers" (if that approach is what is wanted to be followed) just puts us in a weird situation where we have to put a monetary value on a service and would be nicer to treat them separately since it is a different kind of contribution.

Code Contributions

Lastly it would be really nice to show the people who contribute via code (see Astro again at https://docs.astro.build/en/getting-started/ with our very own @dreyfus92 there!):

This would probably make since as a separate PR but wanted to capture the thought here :)

Screenshot 2024-03-03 at 12 46 05

Hopefully that helps a bit. It's not a purely technical implementation that just needs to be coded, there's a bit of trial and error and then asking for feedback from WG (which is why it got stalled on my part).

Of course, if you have any questions along the way then feel free to reach out and ask! 💟

lorenzolewis avatar Mar 03 '24 12:03 lorenzolewis

@lorenzolewis thank you very much for writing this up

Hopefully that helps a bit

This helps a LOT!

It's not a purely technical implementation that just needs to be coded, there's a bit of trial and error and then asking for feedback from WG (which is why it got stalled on my part).

I see

vasfvitor avatar Mar 03 '24 13:03 vasfvitor