search

filecoin-project / devgrants

👟 Apply for a Filecoin devgrant. Help build the Filecoin ecosystem!
Other
377 stars 308 forks source link

Comprehensive Developer Guides - Filecoin Storage API Troubleshooting #1751

Open mendsalbert opened 5 months ago

mendsalbert commented 5 months ago

Project Name: Comprehensive Developer Guides: Filecoin Storage API Troubleshooting

Individual or Entity Name: Albert Mends

Proposer: GitHub username @mendsalbert

Filecoin ecosystem affiliations: I have won numerous Filecoin-sponsored hackathons.

(Optional) Technical Sponsor: N/A

1. What is your project and what existing gap will your project address?

The project aims to develop comprehensive troubleshooting guides for common errors encountered when using the Filecoin Storage API. While the current Filecoin documentation is robust, developers often encounter errors with the Storage API that are not well-documented within the official resources. Instead, solutions are found scattered across external sites like StackOverflow and blogs. This project will consolidate these troubleshooting resources into the official Filecoin documentation, providing a more reliable and centralized resource for developers.

2. How does your project align with our program focus areas?

This project aligns with the focus area of developing comprehensive developer guides by addressing a specific need: troubleshooting common errors with the Filecoin Storage API. By focusing on error resolution and troubleshooting, the project will enhance the current resources available to developers, improving their ability to integrate and utilize the Filecoin Storage API effectively.

3. What are the expected outcomes of the project? What steps will you take to meet this objective?

Number Grant Deliverable Briefly describe how you will meet deliverable objectives Timeframe (within 3 months)
1. Identify Common Errors Research and compile a list of common errors encountered with the Filecoin Storage API. 0.5 months
2. Develop Troubleshooting Guides Create detailed troubleshooting guides for each identified error, providing step-by-step solutions. 1.5 months
3. Community Feedback Engage with the developer community to test and provide feedback on the troubleshooting guides. 0.5 months
4. Finalize and Publish Refine the guides based on feedback and publish them in the official Filecoin documentation. 0.5 months

4. How will you determine if your documentation is successfully supporting your intended audience?

Success will be measured by community engagement and feedback. This will include soliciting feedback from developers who use the documentation, monitoring the usage and success rate of the provided solutions, and ensuring that the documentation effectively resolves common issues. User testing sessions with developers who are not part of the creation team will be conducted to validate the documentation's effectiveness.

5. Will this work be published under the dual MIT and APACHE2 licenses?

Yes.

6. Does your proposal comply with our Community Code of Conduct?

Yes.

Additional Questions:

Team Member Information:

How did you learn about this program?

Through participating in Filecoin-sponsored hackathons.

ErinOCon commented 5 months ago

HI @mendsalbert, thank you for your proposal and for your interest in our grants program! Can you share examples of previous work?

mendsalbert commented 4 months ago

Hi Erin,

Thank you for considering my proposal for the Comprehensive Developer Guides: Filecoin Storage API Troubleshooting project. You can view examples of my previous work at the following link: https://filecoin-storage-api-troubleshooting.netlify.app/

This site showcases various troubleshooting guides and solutions I have developed for common errors encountered with the Filecoin Storage API.

Best regards, Albert Mends GitHub: @mendsalbert Email: mendsalbert@gmail.com

roddy36 commented 4 months ago

Hi @ErinOCon, I wanted to draw your attention to the fact that @mendsalbert is involved in about two other grants (issues #1761 and #1755) which is quite alarming.

mendsalbert commented 4 months ago

Hi @roddy36,

I would like to clarify a few points regarding your concerns. Are you a part of the Filecoin grant team? If not, this matter may not be within your purview. The other grant you mentioned was from a hackathon where I was featured by someone else, and this current grant application was submitted prior to that hackathon.

I believe it would be best to allow the Filecoin grant team to review and decide on this matter. Thank you for your understanding.

Best regards, Albert Mends

ErinOCon commented 4 months ago

Hi @mendsalbert, thank you for your proposal! Would you have availability this week to discuss this project over a call? If so, please share your email address in this thread or by contacting us at grants@fil.org. I can help schedule a time.

ErinOCon commented 3 months ago

Hi @mendsalbert, thank you for connecting with our team last week! This proposal has advanced to our final round of reviews scheduled to be completed by the end of August (if not sooner).

If we have final questions during this review round, I will be in touch. Thank you again for your patience and for your interest in Filecoin documentation!

ErinOCon commented 2 months ago

HI @mendsalbert, thank you for your patience with our review process! We expect to have an update this week.

mendsalbert commented 2 months ago

Thank you for your response! We're looking forward to a positive update. Appreciate your attention to this matter.

ErinOCon commented 1 month ago

HI @mendsalbert, my apologies for the ongoing delay. There are still a few outstanding considerations for the review of this proposal. We expect to have more information available at the beginning of October.

Thank you again for your patience! I know we previously stated that we expected to have an update available earlier this month.

mendsalbert commented 1 month ago

Hi @ErinOCon ,

I hope you’re doing well.

It’s been a little while, and I haven’t heard any updates yet. I just wanted to follow up and see if there’s any news or progress on the review of the proposal.

Thank you again for your time, and I’m looking forward to hearing from you.

Best regards, Albert Mends

mendsalbert commented 4 weeks ago

Hi @ErinOCon ,

I hope you’re doing well.

It’s been a little while, and I haven’t heard any updates yet. I just wanted to follow up and see if there’s any news or progress on the review of the proposal.

Thank you again for your time, and I’m looking forward to hearing from you.

Best regards, Albert Mends