funding.json

[jemgillam]

Description

I have begun a funding.json file. I have kept the comments in it for now, but they will need removing before the final merge into the codebase. Some well-known links will need to be created across our websites. Moved from graphile/crystal#2268

I chose Graphile Worker and PostGraphile as our projects, we can add more, but I feel Grafast might be too new. The whole thing links to Graphile as an organisation any way.

I put in our plans from $100/mo and above.

See floss.fund/funding-manifest

This is a new initiative from zerodha.tech
They launched it last month, the first funding cycle from them is going to start in the new year.

If this initiative gets momentum, then it is worth having a funding.json file anyway, even if FLOSS/fund don't grant us any sponsorship.

Here is a directory of others who have already set this up: dir.floss.fund/browse/projects

Here are the tags we can choose from for our projects: floss.fund/static/project-tags.txt

To Do

• well-known URIs for
  • worker.graphile.org
  • build.graphile.org
  • star.graphile.org
  • postgraphile.org
  • grafast.org
  • graphile.org Not needed
• And in the repos too?
  • worker
  • utils
  • build
  • postgraphile
  • grafast
  • graserv
  • migrate
  • ruru
• include all projects over x stars / downloads
  • grafast
  • grafserv
  • graphile-build
  • graphile-migrate
  • graphile-worker
  • graphile-utils
  • postgraphile
  • ruru
• remove comments
• review wording in descriptions
• readme for star.graphile.org - crystal/utils repo

[jemgillam]

I have added the funding-manifest files to various of our websites

@benjie am I right in thinking the GitHub repos need them too?

"repositoryUrl": {
        "url": "https://github.com/graphile/worker", // Required. URL of the repository where the project's source code and other assets are available. Starts with https:// or http://. Max len 250.
        "wellKnown": "" // Optional. Required if the above url and the URL of the funding.json manifest do not have the same hostname. Starts with https:// or http://. Max len 250.
      },

[jemgillam]

To add to the above, vue.js have one here https://github.com/vuejs/core/blob/main/.well-known/funding-manifest-urls

I have no idea if this works as intended, but it is shown on the FOSS/fund directory as so: https://dir.floss.fund/view/project/@vuejs.org/vuejs

[benjie]

Good research; go with that... I guess?

[jemgillam]

To add onto the above re: links for the repos, I have decided to link to

https://github.com/graphile/crystal/tree/main/graphile-build/graphile-build/.well-known/funding-manifest-urls

rather than

https://raw.githubusercontent.com/graphile/crystal/tree/main/graphile-build/graphile-build/.well-known/funding-manifest-urls

even though the second link is purely the file, the domain is different and so isn't exactly what is required. This approach seems to work for other projects 🤷

[jemgillam]

@benjie ready to look over. I am adding a readme to crystal/utils for the "star" collection of tools/utilities sometime today.

I think we want to discuss some of the wording for the descriptions

[jemgillam]

https://dir.floss.fund/submit gives an error, so a well-known URI is also needed on graphile.org? I don't know if that makes sense from their descriptions...

entity.webpageUrl.url and manifest URL host and paths do not match. Expected entity.webpageUrl.wellKnown for provenance check at https://graphile.org/*/.well-known/funding-manifest-urls