Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation about Project Flare (hole punching, Circuit Relay v2, NAT traveral) #110

Closed
Tracked by #1039
BigLep opened this issue Dec 2, 2021 · 3 comments · Fixed by #112 or #200
Closed
Tracked by #1039
Assignees
Labels
P1 High

Comments

@BigLep
Copy link
Contributor

BigLep commented Dec 2, 2021

Done Criteria

  • Minimum: libp2p public docs doesn't contain any incorrect information about hole punching, circuit relay v2, NAT traversal, etc.
  • Better: there is a way from libp2p public docs for a motivated reader to learn about the above.
  • Best: a reader coming libp2p public docs gets a well organized presentation about how hole punching works in libp2p

Why Important

Hole punching is critical new functionality in libp2p. We need to help customers discover it and get roadsigns on how they can leverage it in their application.

User/Customer

Developers using libp2p in their application who would benefit from the expanded reach that hole-punching provides.

Notes

  1. Given current resourcing, I don't expect us to get to "best". We can close without hitting it. I'd like to push for "better" because this should just mean providing links to some of the existing great documents we have about this effort.
  2. Documentation sources that definitely should be review to at the minimum remove erroneous information are:
    1. https://docs.libp2p.io/concepts/circuit-relay/ (although maybe that was already done in content/concepts/circuit-relay: Update docs to v2 changes #112 ?)
    2. https://docs.libp2p.io/concepts/nat/
  3. Even if we don't get to "best" level, we can still link to many resources that helps a motivated user learn more. This could include blog entires, public talks, spc, etc.
@BigLep BigLep linked a pull request Mar 17, 2022 that will close this issue
@BigLep BigLep changed the title Add documentation about Circuit Relay v2 Add documentation about Project Flare (hole punching, Circuit Relay v2, NAT traveral) Mar 17, 2022
@BigLep
Copy link
Contributor Author

BigLep commented Mar 17, 2022

I expanded the scope of this to be about project flare as a whole rather than just circuit relay v2.

@mxinden
Copy link
Member

mxinden commented Mar 17, 2022

I would suggest copying most of https://blog.ipfs.io/2022-01-20-libp2p-hole-punching/.

@p-shahi p-shahi added the P2 Medium label Aug 26, 2022
@p-shahi
Copy link
Member

p-shahi commented Aug 26, 2022

As a quick win we can link to Max's blog post as well as the paper:
But we will eventually write it.

@p-shahi p-shahi assigned p-shahi and unassigned yusefnapora and mxinden Aug 26, 2022
@salmad3 salmad3 added P1 High and removed P2 Medium labels Sep 22, 2022
@salmad3 salmad3 self-assigned this Sep 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 High
Projects
Archived in project
Status: Done
5 participants