Re-format examples as tutorials

[flyingzumwalt]

Re-format the info in most of these examples as tutorials structured similar to the Railsbridge Curriculum, so that they can be used for self-directed online learning AND for in-person trainings/workshops.

[flyingzumwalt]

I'm starting to sketch this out at https://flyingzumwalt.github.io/ipfs-tutorials/
Note: there's a lot of noise & unnecessary structure in that repo right now. I'll be cleaning it up a lot before I propose the new format.

[dignifiedquire]

Sounds awesome 👍

[flyingzumwalt]

Aside: How to deal with CLI vs. Code Tutorials

Example: "Adding Files to IPFS" is something we can show people how to do 1) using the command line, 2) using the go-ipfs API, 3) using the js-ipfs API, 4) a couple other ways. We don't want to maintain tutorials for all of these. What to do?

For now I'm focusing on command line tutorials. We can use those as the main way to introduce functionality, explain any related concepts, and provide links to further reading. Once we have those, we might be able to get away with having each library merely provide code examples that correspond to each step in the CLI tutorials -- ie. js-ipfs can have a section "How to add a file to IPFS and read it back" and then link to the CLI tutorial for anyone who wants more explanation of the concepts.

I'm not certain this approach will work, but it's good for a first pass.

[RichardLitt]

Focusing on the CLI initially makes the most sense.

[jbenet]

All this sounds great to me!
On Thu, Aug 4, 2016 at 16:35 Richard Littauer [email protected]
wrote:

Focusing on the CLI initially makes the most sense.

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#60 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAIcoaAcl7hk6rOrgvzIRB4bTLb_wJmzks5qck0SgaJpZM4JdBRo
.

[flyingzumwalt]

Note: The tutorial should probably cover all of the uses that @jbenet demonstrates in the IPFS Alpha Demo video

[flyingzumwalt]

FYI: I'm toying with putting the tutorials in a gitbook. See the repo and the rendered book.

[dignifiedquire]

@flyingzumwalt really enjoying the gitbook :)

[em-ly]

I loved the demonstration during the all hands! I think there is a lot of use for this internally as well as externally. Thanks @flyingzumwalt!