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

[CONTENT IMPROVEMENT] Pinning #94

Closed
3 of 5 tasks
Mr0grog opened this issue Jul 25, 2018 · 3 comments
Closed
3 of 5 tasks

[CONTENT IMPROVEMENT] Pinning #94

Mr0grog opened this issue Jul 25, 2018 · 3 comments
Labels
dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours help wanted Seeking public contribution on this issue topic/design-content Content design, writing, information architecture topic/docs Documentation

Comments

@Mr0grog
Copy link
Collaborator

Mr0grog commented Jul 25, 2018

At the Berlin developer summit, we decided pinning was important to write a concept doc about.

Here was the original draft:

Pinning

IPFS nodes treat the data they store like a cache: in theory it could be thrown out at any time and re-retrieved from another node. “Pinning” a CID tells IPFS never to throw out the data associated with that CID — mainly, that means it sicks around after running garbage collection.

Some concerns:

  • Note that ipfs add <filename> automatically pins, while other commands do not.
  • Note that GC is not automatic?
  • Should this talk about future plans around named pins and/or MFS-based pins? (Too speculative, but it should cover MFS “best effort” pinning.)
  • Should this talk about pinning services?
  • Would it be helpful to discuss how you might load some content through the public gateway, but then not be able to do so again a few hours later as an example?

/cc @Stebalien @hsanjuan who were also in this session

This is a subtask of #56.


Concept docs are concise, high-level descriptions of various core concepts in IPFS. They live in the content/guides/concepts folder and should strive to answer:

  1. What is this?
  2. How does it relate to the rest of IPFS?
  3. How can (or should?) you use it? (Note: sometimes the answer is that you should understand it, but not use it. Bitswap is probably a good example.)
  4. Where do you go to learn more?
  5. What is the current state of affairs?
@Mr0grog Mr0grog added help wanted Seeking public contribution on this issue content dif/easy Someone with a little familiarity can pick up labels Jul 25, 2018
rjharmon added a commit to rjharmon/docs that referenced this issue Aug 11, 2018
rjharmon added a commit to rjharmon/docs that referenced this issue Aug 18, 2018
License: MIT
Signed-off-by: Randall Harmon <[email protected]>
@hsanjuan
Copy link
Member

LGTM

Mr0grog added a commit that referenced this issue Aug 20, 2018
Create concept doc for pinning (for #94)
@Mr0grog
Copy link
Collaborator Author

Mr0grog commented Aug 20, 2018

@rjharmon made major improvements in #105. I think we still want to make another pass to address the items about examples with the public gateway and how MFS is like pinning (it’s “best effort” pinned: GC determines MFS attachment by walking down from files in MFS, but if a block in the middle of your tree gets deleted with ipfs block rm, that can orphan all the child nodes and they might get garbage collected because they are technically no longer attached to your MFS).

@meiqimichelle meiqimichelle added topic/design-content Content design, writing, information architecture and removed content labels Jun 4, 2019
@jessicaschilling jessicaschilling changed the title Write concept doc about pinning Concept Doc: Pinning Jul 26, 2019
@jessicaschilling jessicaschilling changed the title Concept Doc: Pinning Augment concept doc on pinning Sep 19, 2019
@jessicaschilling jessicaschilling added effort/hours Estimated to take one or several hours topic/docs Documentation labels Sep 19, 2019
@jessicaschilling jessicaschilling changed the title Augment concept doc on pinning [CONTENT IMPROVEMENT] Pinning Dec 16, 2019
@jessicaschilling
Copy link
Contributor

Closing this issue, since substantial edits have been made in the interim - see https://github.com/ipfs/ipfs-docs-v2/edit/master/docs/concepts/persistence.md .

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours help wanted Seeking public contribution on this issue topic/design-content Content design, writing, information architecture topic/docs Documentation
Projects
None yet
Development

No branches or pull requests

4 participants