ipfs tour #171
Description
It would be great to have ipfs tour give users a tour through the tool, starting at the basics and proceeding. Something like nodeschool.io, but included.
It could work like this. We have a sequence of sections which are just numbered markdown documents: (1, 2, 2.1, 10.1.2, etc). We keep a tour section in the config:
type Tour struct {
Resume string // pointer to doc to show
Read []string // list of tour points "read"
}- Read: have shown it once.
- Completed: we could have a completed list too, but that would warrant tests, like nodeschool.
# show the tour section pointed at by `config.Tour.Resume`
> ipfs tour
# IPFS Tour - 5. Mounting
Like any self-respecting filesystem, IPFS can be mounted onto your
local unix filesystem.
...
# list a bunch of topics (the check denotes "Seen")
> ipfs tour list
- ✓ 0. Hello Mars.
- ✓ 0.1 The tour.
- 1. What is IPFS?
- 1.1 The IPFS stack.
...
- ✓ 5.0 Mounting
- 5.1 Mounting Command
- 5.2 Mounting IPFS
- 5.3 Mounting IPNS
...
# show a specific part
> ipfs tour show 7.
# IPFS Tour - 7. IPNS
IPFS provides a public-key cryptography based namespace. Unlike
other namesystems, IPNS is egalitarian, global, secure, and completely
decentralized.
...
# advance the tour pointer + show
> ipfs tour next
# IPFS Tour - 5.1. Mounting Command
The command to mount IPFS is `ipfs mount`. It can mount both
IPFS and IPNS (you'll learn about IPNS in T 7.1).
...
# resets tour pointer to beginning, wipes Read
> ipfs tour restart
# IPFS Tour - 0. Hello Mars
Welcome to the IPFS Tour! We will walk you through a number of
concepts, features, and tools to make sure you get up to speed
with IPFS very quickly.
First things first, let's test everything works. Try running
ipfs cat Qmafmdamfdmafmadfsafdmas
This should connect to mars.i.ipfs.io, and download a file
using ipfs. It should print out:
> ipfs cat Qmafmdamfdmafmadfsafdmas
Hello, from Mars!
There! Your very own greetings from outer (ipfs) space!
When you're done, run:
ipfs tour nextThe help of the command should look like:
UsageLine: "tour",
Short: "Take the IPFS Tour",
Long: `ipfs tour - Take the IPFS Tour
ipfs tour - Start or resume the tour.
ipfs tour list - Show a list of topics.
ipfs tour show <part> - Show a specific part.
ipfs tour restart - Restart the tour.
This is a tour that takes you through various IPFS concepts,
features, and tools to make sure you get up to speed with
IPFS very quickly. To start, run:
ipfs tour
`,