tour

Documentation

Index

• Variables
• func Chapter(number int) func(topic int) ID
• type Content
• type ID
  • func NextTopic(topic ID) ID
  • func TopicID(t string) ID
  • func (i ID) LessThan(o ID) bool
• type IDSlice
  • func (a IDSlice) Len() int
  • func (a IDSlice) Less(i, j int) bool
  • func (a IDSlice) Swap(i, j int)
• type Topic

Variables

var (
	Introduction = Chapter(0)
	FileBasics   = Chapter(1)
	NodeBasics   = Chapter(2)
	MerkleDag    = Chapter(3)
	Network      = Chapter(4)
	Daemon       = Chapter(5)
	Routing      = Chapter(6)
	Exchange     = Chapter(7)
	Ipns         = Chapter(8)
	Mounting     = Chapter(9)
	Plumbing     = Chapter(10)
	Formats      = Chapter(11)
)

var Daemon_Intro = Content{}

var Daemon_Running_Commands = Content{}

var Daemon_Web_UI = Content{}

var Exchange_Bitswap = Content{}

var Exchange_Getting_Blocks = Content{}

var Exchange_Intro = Content{}

var Exchange_Strategies = Content{}

var FileBasicsAdding = Content{
	Title: "Adding Files",
	Text: `ipfs add
	`,
}

var FileBasicsDirectories = Content{
	Title: "Directories",
	Text: `ipfs ls
	`,
}

var FileBasicsDistributed = Content{
	Title: "Distributed",
	Text: `ipfs cat from mars
	`,
}

var FileBasicsFilesystem = Content{
	Title: "Filesystem",
	Text: `
	`,
}

var FileBasicsGetting = Content{
	Title: "Getting Files",
	Text: `ipfs cat
	`,
}

var FileBasicsMounting = Content{
	Title: "Getting Files",
	Text: `ipfs mount (simple)
	`,
}

var Formats_MerkleDag = Content{}

var Formats_Multiaddr = Content{}

var Formats_Multicodec = Content{}

var Formats_Multihash = Content{}

var Formats_Multikey = Content{}

var Formats_Protocol_Specific = Content{}

var IDs []ID

Topics is a sorted list of topic IDs

var IntroAboutIpfs = Content{
	Title: "About IPFS",
}

var IntroHelloMars = Content{
	Title: "Hello Mars",
	Text: `
	check things work
	`,
}

var IntroTour = Content{
	Title: "Hello Mars",
	Text: `
	how this works
	`,
}

var Ipns_Consistency = Content{}

var Ipns_Mutability = Content{}

var Ipns_Name_System = Content{}

var Ipns_PKI_Review = Content{
	Title: "PKI Review",
	Text: `
	TODO sign verify
	`,
}

var Ipns_Publishing = Content{}

var Ipns_Records_Etc = Content{}

var Ipns_Resolving = Content{}

var MerkleDagContentAddressing = Content{}

var MerkleDagContentAddressingLinks = Content{}

var MerkleDagImmutability = Content{
	Title: "Immutability",
	Text: `
	TODO plan9
	TODO git
	`,
}

var MerkleDagIntro = Content{}

Merkle DAG

var MerkleDagIpfsObjects = Content{}

var MerkleDagIpfsPaths = Content{}

var MerkleDagRedux = Content{}

var MerkleDagUseCaseGitObjects = Content{}

var MerkleDagUseCaseOperationalTransforms = Content{}

var MerkleDagUseCaseUnixFS = Content{}

var Mounting_General = Content{} // TODO note fuse

var Mounting_Ipfs = Content{} // TODO cd, ls, cat

var Mounting_Ipns = Content{} // TODO editing

var Network_Daemon = Content{}

var Network_Exchange = Content{}

var Network_Intro = Content{}

var Network_Ipfs_Peers = Content{}

var Network_Naming = Content{}

var Network_Routing = Content{}

var NodeBasicsConfig = Content{
	Title: "Basics - config",
	Text: `
	`,
}

var NodeBasicsHelp = Content{
	Title: "Basics - help",
	Text: `
	`,
}

var NodeBasicsInit = Content{
	Title: "Basics - init",

	Text: `
	`,
}

var NodeBasicsUpdate = Content{
	Title: "Basics - update",
	Text: `
	`,
}

var Plumbing_Intro = Content{}

var Plumbing_Ipfs_Block = Content{}

var Plumbing_Ipfs_Id = Content{}

var Plumbing_Ipfs_Object = Content{}

var Plumbing_Ipfs_Ping = Content{}

var Plumbing_Ipfs_Refs = Content{}

var Rouing_Interface = Content{}

var Routing_DHT = Content{}

var Routing_Intro = Content{}

var Routing_Other = Content{}

var Routing_Resolving = Content{}

var Topics = map[ID]Topic{}

Topics contains a mapping of Tour Topic ID to Topic

Functions

func Chapter

func Chapter(number int) func(topic int) ID

returns a partially applied function.

It's designed to make it easy to re-order chapters with minimal fuss.

eg.

Intro := Chapter(1)
ID("1.1") == Intro(1) == Chapter(1)(1)

Types

type Content

type Content struct {
	Title string
	Text  string
}

type ID

type ID string

ID is a string identifier for topics

func NextTopic

func NextTopic(topic ID) ID

NextTopic returns the next in-order topic

func TopicID

func TopicID(t string) ID

TopicID returns a valid tour topic ID from given string

func (ID) LessThan

func (i ID) LessThan(o ID) bool

LessThan returns whether this ID is sorted earlier than another.

type IDSlice

type IDSlice []ID

IDSlice implements the sort interface for ID slices.

func (IDSlice) Len

func (a IDSlice) Len() int

func (IDSlice) Less

func (a IDSlice) Less(i, j int) bool

func (IDSlice) Swap

func (a IDSlice) Swap(i, j int)

type Topic

type Topic struct {
	ID ID
	Content
}

Topic is a type of objects that structures a tour topic.