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

New Tutorial: Working with files (non-MFS methods) #203

Closed
terichadbourne opened this issue Apr 23, 2019 · 1 comment · Fixed by #303
Closed

New Tutorial: Working with files (non-MFS methods) #203

terichadbourne opened this issue Apr 23, 2019 · 1 comment · Fixed by #303
Assignees
Labels
docs-ipfs In scope for IPFS Docs Working Group new-tutorial Proposal for a new tutorial OKR 4: ProtoSchool IPFS Docs team 2019 Q4 OKR #4 OKR-2019-Q2 OKR-2019-Q3 OKR-2019-Q4 ProtoSchool Q4 2019 OKR P1 - High

Comments

@terichadbourne
Copy link
Member

Separating out into this new issue the request to build a new tutorial on working with files using the non-MFS commands. (Issue #91 will now be focused only on the MFS tutorial, which will be produced first, via WIP PR #200.)

This tutorial won't be produced until the non-MFS API supports blobs (which @hugomrdias is working on separately).

Here's a quick overview of what the non-MFS lesson structure might look like. See #91 for other conversation around related educational examples.

Teaches regular part of API for files on IPFS (not MFS)
This would be very similar in scope to: https://github.com/ipfs/js-ipfs/tree/master/examples/ipfs-101

  • Introduce how to use @mikeal's new functionality to get files from your desktop to where they can be played with in ProtoSchool
  • Introduce the file API - it uses the dag API (which we learned in previous lessons) under the hood but has lots of extra functionality built in to make it work with files. We could have done this on our own, but the file API saves us time.
  • Add a file with node.add
  • See how the CID is returned
  • (Use the CID to view it on the gateway?)
  • Using that same CID, use node.cat to retrieve the file
  • Show how to add a file using wrapWithDirectory: true so that there will be a path (essentially a filename) and not just a hash returned
  • Use node.get to retrieve the file and see both path and content (highlight differences between cat and get)

As we'll now be framing this as the more advanced file-related lesson, we may also need to make comparisons and reveal some of what was really happening behind the scenes in MFS.

@terichadbourne
Copy link
Member Author

The non-MFS Files API now supports blobs as of v0.36.0 (release notes) and we just updated to 0.36.4 via #251, so it appears our blob blocker has been removed!

@terichadbourne terichadbourne added the docs-ipfs In scope for IPFS Docs Working Group label Jul 25, 2019
@dominguesgm dominguesgm self-assigned this Sep 16, 2019
@terichadbourne terichadbourne added OKR-2019-Q4 ProtoSchool Q4 2019 OKR OKR 4: ProtoSchool IPFS Docs team 2019 Q4 OKR #4 labels Oct 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-ipfs In scope for IPFS Docs Working Group new-tutorial Proposal for a new tutorial OKR 4: ProtoSchool IPFS Docs team 2019 Q4 OKR #4 OKR-2019-Q2 OKR-2019-Q3 OKR-2019-Q4 ProtoSchool Q4 2019 OKR P1 - High
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants