No funded issue found.
Check out the Issue Explorer
Be the OSS Funding you wish to see in the world.
Looking to fund some work? You can submit a new Funded Issue here .
Time left
Opened
Issue Type
Workers Auto Approve
Project Type
Time Commitment
Experience Level
Permissions
Accepted
Reserved For
Infura IPFS Documentation
infura
documentation, ipfs, storage, api, javascript, python, ethereum, infura
This is a Gitcoin bounty to write documentation for the Infura IPFS API.
This documentation will provide a detailed description of each supported IPFS method on Infura's IPFS endpoint, format for calling the methods, and format of the method's response. The description should include common use cases for each method.
An example of API documentation that we really like is Stripe's API documentation here, https://stripe.com/docs/api#intro
In addition to the detailed description, the documentation needs to include example use cases of each method in Javascript. If time allows, additional examples in other languages such as Python are welcome.
Workflow
Prospective bounty claimer will provide examples of previously written documentation and present familiarity with Infura and its IPFS API.
Once approved for the bounty, the person will have a scheduled meeting with one of the maintainers of the IPFS API system. The maintainer will provide a detailed breakdown of the required documentation and answer any questions around the API and its use cases.
The person will then write the documentation per the details in this ticket and the provided information from the maintainer.
The person will submit the documentation within the agreed time frame and will address 2 rounds of feedback in the event that it is needed.
Once the feedback rounds are complete, the bounty reward will be distributed if the acceptance criteria are met.
Acceptance criteria
The documentation has clear information for the following:
API call format for each method
API response examples for each method
Example use cases for all API methods including written description of the example
Any other criteria outlined by the maintainer during the scheduled meeting will be recorded here.
Timeline
The expected time to complete the bounty is 9 hours. The timeline will start after the scheduled meeting with the maintainer. We will discuss an agreed upon timeline during the meeting with the maintainer.
Setup your profile
Tell us a little about you:
Skills
No results found for [[search]] .
Type to search skills..
Bio Required
[[totalcharacter]] / 240
Are you currently looking for work?
[[ option.string ]]
Next
Setup your profile
Our tools are based on the principles of earn (💰), learn (📖), and meet (💬).
Select the ones you are interested in. You can change it later in your settings.
I'm also an organization manager looking for a great community.
Back
Next
Save
Enable your organization profile
Gitcoin products can help grow community around your brand. Create your tribe, events, and incentivize your community with bounties. Announce new and upcoming events using townsquare. Find top-quality hackers and fund them to work with you on a grant.
These are the organizations you own. If you don't see your organization here please be sure that information is public on your GitHub profile. Gitcoin will sync this information for you.
Select the products you are interested in:
Out of the box you will receive Tribes Lite for your organization. Please provide us with a contact email:
Email
Back
Save
