Skip to content
This repository was archived by the owner on Jun 2, 2020. It is now read-only.

Setup some structure #41

Merged
merged 1 commit into from
Nov 8, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@
title: "IPFS Documentation"
---


# IPFS Documentation

Welcome! Here you will find documentation and guides you can use to get started working with the distributed web and IPFS.

{{%children style="h2" description="true"%}}


[[TODO: Fit implementation specific stuff such as plugins somewhere]]
9 changes: 9 additions & 0 deletions content/api/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
+++
title = "API"
description = "[[TODO]]"
weight = 2
+++

[[TODO: Auto-generate as much as possible]]

{{%children style="h2" description="true"%}}
7 changes: 7 additions & 0 deletions content/api/cli/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = "Command-Line Interface"
description = "The standard ipfs commands"
weight = 1
+++

[[TODO: Generate, possibly a separate file per command family]]
7 changes: 7 additions & 0 deletions content/api/http-api/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = "HTTP Interface"
description = "The http deamon API"
weight = 2
+++

[[TODO: Generate]]
5 changes: 5 additions & 0 deletions content/api/js/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
+++
title = "JavaScript Interface"
description = "The standard JS API"
weight = 3
+++
7 changes: 7 additions & 0 deletions content/components/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = "Components"
description = "All the inner-workings"
weight = 3
+++

{{%children style="h2" description="true"%}}
7 changes: 7 additions & 0 deletions content/components/bitswap/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = "BitSwap"
description = ""
weight = 6
+++

[[TODO: Write this]]
13 changes: 13 additions & 0 deletions content/components/ipld/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
+++
title = "IPLD"
description = "InterPlanetary Linked Data"
weight = 4
+++

[[TODO: Description]]

{{%children style="h2" description="false"%}}

## IPLD Paths

## Resolvers
4 changes: 4 additions & 0 deletions content/components/ipld/cid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
+++
title = "Content Identifiers - CID"
description = "Content Identifier details"
+++
11 changes: 11 additions & 0 deletions content/components/libp2p/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
+++
title = "LibP2P"
description = ""
weight = 7
+++

[[TODO: Write this]]

## Architecture

[[TODO: Write per-module docs]]
9 changes: 9 additions & 0 deletions content/components/multiformats/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Multiformats"
description: ""
weight: "3"
---

[[TODO: Description from repo, links]]

{{%children style="h2" description="true"%}}
7 changes: 7 additions & 0 deletions content/components/multiformats/multiaddr/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = "MultiAddr"
description = "Composable and future-proof network addresses"
weight = 3
+++

[[TODO: Description, links]]
7 changes: 7 additions & 0 deletions content/components/multiformats/multibase/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = "MultiBase"
description = "Self identifying base encodings"
weight = 2
+++

[[TODO: Description, links]]
7 changes: 7 additions & 0 deletions content/components/multiformats/multicodec/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = "MultiCodec"
description = "Compact self-describing codecs"
weight = 4
+++

[[TODO: Description, links]]
7 changes: 7 additions & 0 deletions content/components/multiformats/multihash/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = "MultiHash"
description = "Self describing hashes"
weight = 1
+++

[[TODO: Description, links]]
7 changes: 7 additions & 0 deletions content/components/multiformats/multistream/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = "MultiStream"
description = "Self describing streams"
weight = 5
+++

[[TODO: Description, links]]
9 changes: 9 additions & 0 deletions content/components/unixfs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
+++
title = "UnixFS"
description = ""
weight = 5
+++

UnixFS an IPFS specific merkle tree foramt based on Git.

[[TODO: Expand, give enough details for users to be able to create objects from scratch]]
7 changes: 7 additions & 0 deletions content/config/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = "Configuration"
description = "Configure your node"
weight = 4
+++

{{%children style="h2" description="true"%}}
7 changes: 7 additions & 0 deletions content/config/go/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = "Go-IPFS"
description = "Go-IPFS specific configuration"
weight = 1
+++

[[TODO: Import https://github.com/ipfs/go-ipfs/tree/master/docs]]
7 changes: 7 additions & 0 deletions content/config/js/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = "JS-IPFS"
description = "JS-IPFS specific configuration"
weight = 2
+++

[[TODO: Wirte this]]
7 changes: 7 additions & 0 deletions content/getting-started/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Getting Started"
description: "Learn the basics"
weight: "1"
---

{{%children style="h2" description="true"%}}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
+++
title = "Getting Started"
description = "Setting up IPFS and beginning usage"
weight = 2
title = "Basic usage"
description = "Learn the basics"
weight = 3
+++

If you haven't done so, [install IPFS](../installation).
Expand All @@ -10,13 +10,15 @@ If you haven't done so, [install IPFS](../installation).

During this tutorial, if you have any questions, feel free to ask them in [https://discuss.ipfs.io/](https://discuss.ipfs.io/) or in [#ipfs on chat.freenode.net](irc://chat.freenode.net/%23ipfs).

The steps described here should be roughly the same for JS-IPFS, though keep in mind that this guide was written for the Go implementation.

## init the repo

`ipfs` uses a global local object repository, added to `~/.ipfs`:
`ipfs` uses a global local object repository, located at `~/.ipfs`. It needs to be initialized before it can be used.

```sh
> ipfs init
initializing ipfs node at /Users/jbenet/.go-ipfs
initializing ipfs node at /Users/username/.go-ipfs
generating 2048-bit RSA keypair...done
peer identity: Qmcpo2iLBikrdf1d6QU6vXuNb6P7hwrbNPW9kLAH8eG67z
to get started, enter:
Expand Down Expand Up @@ -140,6 +142,8 @@ I <3 IPFS -<your username>

By default, your gateway is not exposed to the world, it only works locally.

[[TODO: Section on IPNS?]]

## Fancy Web Console

We also have a web console you can use to check the state of your node.
Expand All @@ -150,9 +154,3 @@ On your favorite web browser, go to:
This should bring up a console like this:

<img class="screenshot" alt="Web console connection view" src="/images/webui-connection.png">

Now, you're ready:

<a class="button button-primary" href="/examples" role="button">
Onward to more Examples &nbsp;&nbsp;<i class="fa fa-arrow-right"></i>
</a>
Loading