Make Tour Skeleton

[jbenet]

No description provided.

[jbenet]

Beginning

---

IPFS Tour

Below are some potential tour topics. The numbers dont begin with sig digit, as order is still tbd.

Introduction

0.0 Hello Mars - check things work
0.1 Tour - how this works
0.2 About IPFS

File Basics

.0 Filesystem
.1 Getting Files - ipfs cat
.2 Adding Files - ipfs add
.3 Directories - ipfs ls
.4 Distributed - ipfs cat from mars
.5 Mounting - ipfs mount (simple)

Node Basics

.0 Basics - init
.1 Basics - help
.2 Basics - update
.3 Basics - config

Merkle DAG

.0 The Merkle DAG
.1 Content Addressing
.2 Content Addressing Links
.3 The Merkle DAG Redux
.4 IPFS Objects
.5 IPFS Paths
.6 Immutability (plan9, git)
.7 Use Case - unixfs
.8 Use Case - git objects
.9 Use Case - operational transforms

Network

.0 The Network
.1 IPFS Peers
.2 Daemon
.3 Routing
.4 Exchange
.5 Naming

Daemon

.0 Daemon
.1 Daemon - Running Commands
.2 Daemon - WebUI

Routing

.0 Routing
.1 Routing - Interface
.2 Routing - Resolving
.3 Routing - DHT
.4 Routing - Other

Exchange

.0 Exchange
.1 Exchange - BitSwap
.2 Exchange - Strategies
.3 Exchange - Getting Blocks

IPNS

.0 IPNS - Name System
.1 IPNS - Mutability
.2 IPNS - PKI review (sign, verify)
.3 IPNS - Publishing
.4 IPNS - Resolving
.5 IPNS - Consistency
.6 IPNS - Records, links.

Mounting

.0 Mounting - note FUSE
.1 mount ipfs - cd, ls, cat
.2 mount ipns - editing

Plumbing

.0 Plumbing
.1 Plumbing - ipfs block
.2 Plumbing - ipfs object
.3 Plumbing - ipfs refs
.4 Plumbing - ipfs ping
.5 Plumbing - ipfs id

Formats

.0 Formats - MerkleDAG
.1 Formats - multihash
.2 Formats - multiaddr
.3 Formats - multicodec
.4 Formats - multikey
.5 Formats - protocol-specific

[jbenet]

@whyrusleeping @maybebtc @mappum @cryptix anything glaringly missing ^

[btc]

The distinction between (a) announcing/broadcasting all of your added data to the network and (b) not. Not sure where that fits.

[whyrusleeping]

Yeah, where is pinning mentioned?

[btc]

@whyrusleeping When you say pinning, you mean broadcasting, right?

I think this is what is meant by pinning:
http://en.wikipedia.org/wiki/Virtual_memory#Pinned_pages

To avoid confusion, in our communication and docs, we may need to agree on lexicon and distinguish between these different behaviors.

[jbenet]

1. pinning ensuring a block is kept in local storage (i.e. not evicted from cache).
2. providing advertising to the world that a node can serve a block.

@whyrusleeping @maybebtc does this distinguish them?

[btc]

yes

[whyrusleeping]

👍

[btc]

Identity

This is somewhat relevant at ipfs init since the generated key pair is the basis for the node's identity in the network. A cursory nod may be sufficient at that stage, and goes a long way in explaining init's raison d'être.

NB: user is introduced to ipfs init before ipfs add.

edit: err

[whyrusleeping]

agreed, since they will have to run it before ipfs init anyways.

[whyrusleeping]

Also, maybe a section under Daemon mentioning the fact that they can easily write their own code to communicate with the local ipfs daemon? Its always cool to just be able to netcat to a port and fire commands off

[jbenet]

Thanks guys!

So far, at least these additions:

• pinning section
• providing (exchange - providers, exchange - providing)
• identity, talk about pki. (ipfs init section)
• daemon - {API, API Clients, Example} (i like how old-school http + ftp clients show it)
• bootstrapping

edits:

• + bootstrapping

[btc]

+ bootstrapping

[btc]

structure

https://github.com/jbenet/go-ipfs/pull/269/files#diff-21f45d3398a679604e25bd662d1a299e

[leerspace]

Is this still something wanted? It looks like the tour command has recently been scrapped entirely in #4123.

[ghost]

Yeah we're not gonna incorporate this for the time being -- thanks for pinging!