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

New IPFS explainer #170

Merged
merged 79 commits into from
Aug 30, 2019
Merged

New IPFS explainer #170

merged 79 commits into from
Aug 30, 2019

Conversation

meiqimichelle
Copy link
Contributor

@meiqimichelle meiqimichelle commented May 20, 2019

See content/introduction/how-ipfs-works.md for most of the changes (that's where the new content lives).

Reference Mural (aka, where this all began), which is based on a lot of work with @lanzafame, @hsanjuan, @flyingzumwalt (and others I'm sure I'm forgetting! ping me, plz)

This is a continuation of #168, which I closed so I could make separate branch with the initial copyedits to existing content that turned out were necessary before I could start this new content.

This is based on those copyedits; #169 must merge first to avoid merge conflict headaches.

@meiqimichelle meiqimichelle changed the title [WIP] New IPFS explainer New IPFS explainer May 21, 2019
@meiqimichelle meiqimichelle marked this pull request as ready for review May 21, 2019 07:37
@meiqimichelle
Copy link
Contributor Author

This is still a ways off, I'm sure -- but it is good enough for discussion and review. We may need to copy this back out into a Google doc for easier in-depth editing/hacking. The images are VERY VERY VERY placeholder-y. Those might turn into nav, or icons, or nothing at all, and completely different illustrations of completely different parts might be more appropriate.

Calling @flyingzumwalt @jessicaschilling for 👀 at the start.

@meiqimichelle
Copy link
Contributor Author

I'm going to ask for wider review -- I think @jessicaschilling and @flyingzumwalt are busy this week! They can loop back when they have time :)

content/introduction/overview.md Outdated Show resolved Hide resolved
content/introduction/overview.md Outdated Show resolved Hide resolved
content/introduction/overview.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/overview.md Outdated Show resolved Hide resolved
content/introduction/overview.md Outdated Show resolved Hide resolved
Copy link
Member

@hsanjuan hsanjuan left a comment

Choose a reason for hiding this comment

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

This is a good start! Thank you!

We should be careful to not be inaccurate or misrepresent things. For a very introductory guide to IPFS we can probably live without mentioning IPLD and reduce Merkle-DAGs as something representing content-addressed files and folders.

I hope we can get more reviews from the IPFS teams!

content/_index.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/overview.md Outdated Show resolved Hide resolved
@meiqimichelle
Copy link
Contributor Author

Ok, y'all. I believe I've resolved or left comments on all your feedback and edits.

Also, I did a few quick passes on the text to make it a touch less informal. (For example, my previous draft had a lot of ❗️s. It was excessive; I must have been really excited that day 😆 .)

@hsanjuan
Copy link
Member

(On my radar, will review when I have some time).

(Promise this will be soonTM)

(You are welcome to spam me constantly about this)

@jessicaschilling
Copy link
Contributor

Thanks, @hsanjuan -- please consider yourself spammed on this one. :)

Copy link
Member

@hsanjuan hsanjuan left a comment

Choose a reason for hiding this comment

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

Minor comments, ok to move forward.

content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/how-ipfs-works.md Outdated Show resolved Hide resolved
content/introduction/overview.md Outdated Show resolved Hide resolved
Fixes typo found in #170 (comment)
Added info on Bitswap improvement proposal as suggested by @hsanjuan in #170 (comment)
Fixed typo and incorporated edits from @hsanjuan in #170 (comment)
Fixes typo and addresses comments from @hsanjuan from #170 (comment)
Incorporate suggestions from #170 (comment)
Removed references to "flavored" per #170 (comment)
Changes subhead per @warpfork suggestion in #170 (comment)
@jessicaschilling jessicaschilling merged commit 3baf16e into master Aug 30, 2019
@jessicaschilling
Copy link
Contributor

Incorporated remaining changes from Hector and others, and shipped!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
topic/design-content Content design, writing, information architecture
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants