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

Update diagrams for Hole Punching article #207

Closed
p-shahi opened this issue Oct 18, 2022 · 1 comment
Closed

Update diagrams for Hole Punching article #207

p-shahi opened this issue Oct 18, 2022 · 1 comment
Assignees
Labels
type:enhancement Content enhancement, new feature or request.

Comments

@p-shahi
Copy link
Member

p-shahi commented Oct 18, 2022

We currently use UML sequence diagrams in the Hole Punching documentation:
image

We need to replace these with updated diagrams when they become available.


See the discussion here: https://github.com/libp2p/docs/pull/200/files#r980363822

@p-shahi p-shahi added P2 Medium type:enhancement Content enhancement, new feature or request. labels Oct 18, 2022
@salmad3 salmad3 moved this to In Progress in libp2p Product Oct 19, 2022
@salmad3 salmad3 moved this from In Progress to Planned in libp2p Product Oct 19, 2022
@salmad3 salmad3 self-assigned this Nov 17, 2022
@salmad3 salmad3 added P2 Medium and removed P2 Medium labels Jan 16, 2023
@salmad3
Copy link
Member

salmad3 commented Jan 22, 2023

Given the nature of this issue in comparison to #206, we can track the scope of this issue in 206 as the diagrams here would, in part, also be used for other docs in the NAT section, and we are tracking all the other diagram updates in 206.

Going forward, we should follow the libp2p blog post approach and include new diagrams and graphics as part of the change request. However, given that the open PRs (many documenting protocols and process) have been hanging for some time, my approach was to get those merged and add the diagrams shortly after to limit the friction.

In the near term where there is little to no "doc debt", we'll make it a habit to request diagrams as documents are created and ship them together.

@salmad3 salmad3 closed this as completed Jan 22, 2023
@github-project-automation github-project-automation bot moved this from Planned to Done in libp2p Product Jan 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:enhancement Content enhancement, new feature or request.
Projects
Status: Done
Development

No branches or pull requests

2 participants