Skip to content
This repository was archived by the owner on Jun 2, 2020. It is now read-only.

[NEW CONTENT] [BOUNTY] High-level doc of usage ideas and examples #387

Closed
jessicaschilling opened this issue Nov 26, 2019 · 15 comments · Fixed by ipfs/ipfs-docs#205
Closed
Assignees
Labels
bounty Has bounty! See https://github.com/ipfs/devgrants/projects/1 dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week help wanted Seeking public contribution on this issue P2 Medium: Good to have, but can wait until someone steps up topic/design-content Content design, writing, information architecture topic/docs Documentation

Comments

@jessicaschilling
Copy link
Contributor

jessicaschilling commented Nov 26, 2019

This issue is one of the prioritized recommendations in the Q1 2020 IPFS Ecosystem Audit for execution in Q2/Q3 2020. Tagging it with $auditrecommendation means it's searchable! See all tagged issues in this repo.

This issue has a bounty!

Successfully closing this issue by producing a production-ready piece of documentation can earn you not only the undying love of the IPFS community — it can net you a financial reward. See the current list of bounty issues and their values here.

The need in brief

As identified by Q3/Q4 2019 user testing, create a high-level document offering ideas for use cases of IPFS, as well as active/prominent/standout examples of these use cases in action, when they exist.

It may also be useful to provide direction to the best repos to look at for someone considering a common use case. @eshon provides Twitter Open Source's projects page as an example for how to potentially present this info: https://twitter.github.io/projects.html

The target audience for this may not be the hardcore or dweb-experienced developer: it may be more useful to keep in mind the technically proficient, but not necessarily in-the-weeds active, technologist or engineering manager who needs to understand where IPFS can help them achieve their existing goals and where it might fit into their overall tech stack. To this end, it'll be helpful to use the IPFS goal-based personae as a starting point.

Deliverable

A concise, high-level high-level document offering ideas for use cases of IPFS, as well as active/prominent/standout examples of these use cases in action, when they exist

Content should take the form of a Markdown document, supplemented by diagrams or other appropriate helper content as embedded images. File locations should be as follows:

Guidelines

  • Please use the IPFS Docs Contributor Guidelines as your north star — adherence to these guidelines are crucial when it comes to awarding potential bounty!
  • Also, please keep in mind our core user personae. If a piece of content serves one or more personae in particular, make sure it checks out with that persona's attributes.
@jessicaschilling jessicaschilling added docs-ipfs topic/docs Documentation topic/design-content Content design, writing, information architecture dif/medium Prior experience is likely helpful help wanted Seeking public contribution on this issue effort/days Estimated to take multiple days, but less than a week labels Nov 26, 2019
@jessicaschilling jessicaschilling changed the title Create high-level doc of usage ideas and examples [NEW CONTENT] High-level doc of usage ideas and examples Dec 16, 2019
@jessicaschilling jessicaschilling changed the title [NEW CONTENT] High-level doc of usage ideas and examples [NEW CONTENT] [BOUNTY] High-level doc of usage ideas and examples Dec 19, 2019
@vasa-develop
Copy link

vasa-develop commented Jan 7, 2020

@jesseclay

MD content should live here (lease make a PR against the existing placeholder document) https://github.com/ipfs/ipfs-docs-v2/blob/master/docs/essentials/usage-ideas-examples.md

Seems like this link is broken.

I think I can pick this one up.

@jessicaschilling
Copy link
Contributor Author

jessicaschilling commented Jan 7, 2020

@vasa-develop
Copy link

vasa-develop commented Jan 8, 2020

@jessicaschilling who should I contact to get feedback on my drafts of this task?

@jessicaschilling
Copy link
Contributor Author

@vasa-develop That’d be @johnnymatthews 😊

@johnnymatthews johnnymatthews added the P2 Medium: Good to have, but can wait until someone steps up label Jan 9, 2020
@johnnymatthews
Copy link
Contributor

Hi @vasa-develop, sorry I've just gotten around to this. The best way to post your drafts is to create a fork of ipfs/ipfs-docs-v2 and share that fork here. Then I'll be able to add comments directly in your fork. Once everything's good to go, you can make a PR into ipfs/ipfs-docs-v2 and we can get things merged.

@jessicaschilling
Copy link
Contributor Author

@vasa-develop -- what's the status on this? Would like to open up this bounty issue to other contributors if you're no longer interested. Thank you!

@bertrandfalguiere
Copy link
Contributor

I can take this on if @vasa-develop has no time available for the time being.

@jessicaschilling
Copy link
Contributor Author

@vasa-develop -- please let us know by Wednesday 5 Feb if you're available to work this. If not or we don't hear from you, we'll re-assign to @bertrandfalguiere so he can get to work. Thanks both!

@jessicaschilling
Copy link
Contributor Author

Un-assigning @vasa-develop in absence of his confirmation he's still available to work on this issue. @bertrandfalguiere, assigning if you if you'd still like to work on this. Please confirm.

@bertrandfalguiere
Copy link
Contributor

I'm on it. Thanks for the assignation.

@bertrandfalguiere
Copy link
Contributor

@vasa-develop Yes, why not, that's kind :)

@johnnymatthews
Copy link
Contributor

Hi @bertrandfalguiere, how's things going with this? If you need any extra support, let us know here!

@johnnymatthews
Copy link
Contributor

Re-opening this issue. If you're still working on things @bertrandfalguiere, I'll re-assign it to you.

@johnnymatthews johnnymatthews added the bounty Has bounty! See https://github.com/ipfs/devgrants/projects/1 label May 7, 2020
@bertrandfalguiere
Copy link
Contributor

Yeah, sorry, I got lost in the tens and tens of uses cases. 😬 Expect a first PR tomorrow or Saturday.

@johnnymatthews
Copy link
Contributor

Ok cool, thanks for the update.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bounty Has bounty! See https://github.com/ipfs/devgrants/projects/1 dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week help wanted Seeking public contribution on this issue P2 Medium: Good to have, but can wait until someone steps up topic/design-content Content design, writing, information architecture topic/docs Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants