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

[NEW CONTENT] [BOUNTY] Quick overview of libp2p with deep linking to its docs #388

Closed
jessicaschilling opened this issue Nov 26, 2019 · 10 comments
Assignees
Labels
dif/medium Prior experience is likely helpful effort/hours Estimated to take one or several hours help wanted Seeking public contribution on this issue P3 Low: Not priority right now topic/design-content Content design, writing, information architecture topic/docs Documentation

Comments

@jessicaschilling
Copy link
Contributor

jessicaschilling commented Nov 26, 2019

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

A quick, high-level explainer of libp2p that doesn't seek to replace any of the excellent libp2p docs, but rather provides topically specific entry points to key content in those docs for folks who want to dig deeper. In other words, we'd like a 10k-foot overview of libp2p on the IPFS docs for those who don't know what it is yet -- but we don't want to simply link the reader to libp2p docs without any initial context.

Deliverable

A concise, high-level description of this IPFS concept. It should answer the following, supplemented whenever possible by diagrams, videos and/or code examples:

  • What is this?
  • How does it relate to the rest of IPFS?
  • What are some generic use cases for this — how might it meet a need in someone's project/goal?
  • How can (or should?) you use it? (Note: sometimes the answer is that you should understand it, but not necessarily use it based on your use case or the current state of the tech.)
  • Where do you go to learn more?
  • What is the current state of this concept or technology?

Content should take the form of a Markdown document, supplemented by diagrams 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 dif/medium Prior experience is likely helpful help wanted Seeking public contribution on this issue effort/hours Estimated to take one or several hours topic/design-content Content design, writing, information architecture labels Nov 26, 2019
@jessicaschilling jessicaschilling changed the title Quick overview of libp2p with deep linking to its docs [NEW CONTENT] Quick overview of libp2p with deep linking to its docs Dec 16, 2019
@jessicaschilling jessicaschilling changed the title [NEW CONTENT] Quick overview of libp2p with deep linking to its docs [NEW CONTENT] [BOUNTY] Quick overview of libp2p with deep linking to its docs Dec 19, 2019
@vasa-develop
Copy link

@jesseclay

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

The link to the placeholder link seems to be broken.

How can (or should?) you use it? (Note: sometimes the answer is that you should understand it, but not necessarily use it based on your use case or the current state of the tech.)

I didn't get this. Can you elaborate a bit on this point?

@jessicaschilling
Copy link
Contributor Author

@vasa-develop - thanks for catching that broken link, it should be https://github.com/ipfs/ipfs-docs-v2/blob/master/docs/concepts/libp2p.md

As for the second bit: This really means just to remember that a variety of levels of expertise will be reading this piece of documentation. Some folks just want to know what libp2p is at the most basic level; others want to know how it might be useful to them without having to dig too deep into dev-specific details; others want those deep details. In the case of the libp2p page on the IPFS docs, since there's already an entire libp2p documentation site out there on libp2p.io, we want to give them a high-level explainer of libp2p, but if they want to go deeper, give them good, meaty, contextual deep links into specific useful areas in the libp2p docs.

@bertrandfalguiere
Copy link
Contributor

If @vasa-develop doesn't take this on, I can do it.

@jessicaschilling
Copy link
Contributor Author

@bertrandfalguiere -- any other open issues for new content that catch your fancy? You can see them all here: https://github.com/ipfs/docs/labels/Category%3A%20Content

@bertrandfalguiere
Copy link
Contributor

I have a good understanding of the concepts and how things work together but haven't dug into the code. So the only issues I can work on are this one, the Glossary and the usage examples.
I wish to work on any of them.

@johnnymatthews johnnymatthews added the P3 Low: Not priority right now label Jan 9, 2020
@jessicaschilling
Copy link
Contributor Author

@bertrandfalguiere -- This is a bit off-topic, but might you be interested in this issue? ipfs-inactive/website#352
(cc @johnnymatthews)

@jessicaschilling
Copy link
Contributor Author

@edgo914 - looks like you’ve claimed this. Assigning.

@edgo914
Copy link

edgo914 commented Feb 11, 2020

@jessicaschilling thanks, I'm on it

@johnnymatthews
Copy link
Contributor

Closed through PR 122.

@momack2
Copy link
Contributor

momack2 commented Mar 26, 2020

@johnnymatthews / @jessicaschilling can you ensure we pay this out and move to the "paid" column of the bounty board?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dif/medium Prior experience is likely helpful effort/hours Estimated to take one or several hours help wanted Seeking public contribution on this issue P3 Low: Not priority right now topic/design-content Content design, writing, information architecture topic/docs Documentation
Projects
None yet
Development

No branches or pull requests

6 participants