Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

docs: add IPFS Architecture Diagram #1673

Merged
merged 2 commits into from
Dec 4, 2018
Merged

docs: add IPFS Architecture Diagram #1673

merged 2 commits into from
Dec 4, 2018

Conversation

daviddias
Copy link
Member

@daviddias daviddias commented Oct 27, 2018

I took some time to design the current IPFS Architecture so that we could have more informed discussions.

architecture

You can see it as png, txt or a monodraw file.

This diagram presents what the architecture is today and not what is next (the dashed boxes for the internal pieces also don't exist but that is where they fit the puzzle).

@ghost ghost assigned daviddias Oct 27, 2018
@ghost ghost added the status/in-progress In progress label Oct 27, 2018
@daviddias
Copy link
Member Author

image

@vmx
Copy link
Member

vmx commented Oct 29, 2018

You mentio

They represent what is there today and not what is next.

Graph Service/GraphSync isn't a thing yet, so I think it shouldn't be in the diagram.

@daviddias
Copy link
Member Author

daviddias commented Oct 29, 2018

@vmx the internal pieces in boxes with dashed pattern mean that they are in progress/missing but that is where they fit on the picture today. My bad for not explaining that right away, updated the description.

@vmx
Copy link
Member

vmx commented Oct 29, 2018

@diasdavid K, cool. It would be nice if the diagram would have a legend what dashed boxes mean.

@alanshaw
Copy link
Member

@diasdavid can we replace the diagram here with it please?

@daviddias
Copy link
Member Author

@alanshaw absolutely. I was expecting a bit more question/discussion, but if everyone simply agrees with this and likes it, then all good to me! :)

@alanshaw
Copy link
Member

@alanshaw absolutely. I was expecting a bit more question/discussion, but if everyone simply agrees with this and likes it, then all good to me! :)

Ok cool! I think it's great and there's not a lot to say about it since that IS the architecture. It's much better than the existing diagram already. Some feedback tho:

  • Could possibly be a bit wider? Feels a little squashed.
  • Graph service - maybe put "(IPLD)" in the diagram
  • pubsub, IPNS, DHT, Swarm do they belong in here?
  • I think some explanatory text underneath (when added to the README) would be beneficial (basically your annotations from docs: add IPFS Architecture Diagram #1673 (comment))

Copy link
Member

@vasco-santos vasco-santos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems awesome to me!

I am just not sure if we should add IPNS in this diagram, as well!

@alanshaw
Copy link
Member

ping @daviddias

@daviddias
Copy link
Member Author

Added to my TODO list for this week

@daviddias
Copy link
Member Author

Applied CR :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants