Skip to content

Commit 0f085db

Browse files
authored
Updated navigation for ipfs-docs (ipfs#1405)
1 parent 4bea32e commit 0f085db

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+613
-572
lines changed

docs/.vuepress/config.js

Lines changed: 289 additions & 261 deletions
Large diffs are not rendered by default.

docs/.vuepress/redirects

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
1+
/basics/ /install/
2+
/basics/desktop-app /how-to/desktop-app
3+
/basics/go/command-line-quick-start /how-to/command-line-quick-start
4+
/basics/js/js-ipfs /install/js-ipfs
5+
/basics/ipfs-implementations /concepts/ipfs-implementations
16
/community/contribute/ /project/contribute
27
/community/contribute/how-to-help/ /project/contribute
38
/concepts/privacy /concepts/privacy-and-encryption
49
/concepts/ipld/ https://ipld.io/docs/intro/primer/
10+
/concepts/case-study-arbol /case-studies/arbol
11+
/concepts/case-study-audius /case-studies/audius
12+
/concepts/case-study-fleek /case-studies/fleek
13+
/concepts/case-study-likecoin /case-studies/likecoin
14+
/concepts/case-study-morpheus /case-studies/morpheus
15+
/concepts/case-study-snapshot /case-studies/snapshot
516
/docs/install /install
617
/guides/ /how-to
718
/guides/concepts/ /concepts
@@ -29,12 +40,14 @@
2940
/guides/guides/install/ /install
3041
/how-to/host-single-page-site /how-to/websites-on-ipfs/single-page-website
3142
/how-to/troubleshoot-file-transfers /how-to/troubleshooting
43+
/how-to/run-ipfs-inside-docker /install/run-ipfs-inside-docker
3244
/install/command-line-quick-start/ /how-to/command-line-quick-start
3345
/introduction/ /concepts
3446
/introduction/faq/ /concepts/faq
3547
/introduction/how-ipfs-works/ /concepts/how-ipfs-works
3648
/introduction/overview/ /concepts/what-is-ipfs
3749
/introduction/usage/ /how-to/command-line-quick-start
50+
/install/ipfs-updater /how-to/ipfs-updater
3851
/install/recent-releases/ https://github.com/ipfs/kubo/releases
3952
/install/recent-releases/go-ipfs-0-5/ https://github.com/ipfs/kubo/releases
4053
/install/recent-releases/go-ipfs-0-5/features/ https://github.com/ipfs/kubo/releases

docs/.vuepress/theme/styles/index.styl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,3 +85,9 @@ section.tabs-component-panel::before {
8585
height: 10em;
8686
margin-top: -10em;
8787
}
88+
89+
.nav-links{
90+
margin-right: 10%;
91+
margin-left: 10%;
92+
float: left;
93+
}

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ Are you looking for inspiration? You can find a huge collection of awesome commu
6161

6262
IPFS has a bustling community of designers, developers, writers, and activists who are all helping to improve the project. You can join in by attending a local meetup, helping out at a conference, chatting online through [Discord](https://discord.com/invite/KKucsCpZmY), or joining a discussion in [the IPFS forum](https://discuss.ipfs.tech/).
6363

64-
[Find out more in the Community section →](community/README.md)
64+
[Find out more in the Community section →](community/README.md)

docs/concepts/case-study-arbol.md renamed to docs/case-studies/arbol.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ _— Ben Andre, CTO, Arbol_
1414
## Overview
1515

1616
::: right
17-
<img src="./images/case-studies/logo-arbol.svg" alt="Arbol logo" width="220">
17+
<img src="./images/logo-arbol.svg" alt="Arbol logo" width="220">
1818
:::
1919

2020
[Arbol](https://www.arbolmarket.com/) is a software platform that connects agricultural entities like farmers and other weather-dependent parties with investors and other capital providers to insure and protect against weather-related risks. Arbol's platform sells contracts for parametric weather protection agreements in a marketplace that's an innovative, data-driven approach to risk management, cutting out the usual legacy insurance claims process of making loss assessments on the ground. Instead, Arbol relies on tamper-proof data indexes to determine payouts, and doesn't require a defined loss to be indemnified. Arbol's platform combines parametric weather protection with blockchain-based smart contracts to provide cost-efficient, automated, and user-defined weather-related risk hedging. As with traditional crop insurance and similar legacy products, end users purchase assurance that they'll be financially protected in the case of adverse weather — but with Arbol, these end users are paid automatically if adverse conditions occur, as defined by the contract and measured by local meteorological observations tracked by Arbol's data sources.
2121

22-
To build the data indexes that Arbol uses to handle its contracts, the team aggregates and standardizes billions of data files comprising decades of weather information from a wide range of reputable sources — all of which is stored on IPFS. IPFS is critical to Arbol's service model due to the inherent verifiability provided by its [content-addressed architecture](content-addressing.md), as well as a decentralized data delivery model that facilitates Arbol's day-to-day aggregation, synchronization, and distribution of massive amounts of data.
22+
To build the data indexes that Arbol uses to handle its contracts, the team aggregates and standardizes billions of data files comprising decades of weather information from a wide range of reputable sources — all of which is stored on IPFS. IPFS is critical to Arbol's service model due to the inherent verifiability provided by its [content-addressed architecture](../concepts/content-addressing.md), as well as a decentralized data delivery model that facilitates Arbol's day-to-day aggregation, synchronization, and distribution of massive amounts of data.
2323

2424
While United States agribusiness has been Arbol's initial area of focus, the team has built a globally capable platform, with expansion underway to new regions and industries around the world. Arbol currently provides contracts for managing the risks of weather exposure in the energy and agriculture sectors, and features both custom and pre-designed protection agreements for clients across industries and scale. Their current end-user base ranges from small coffee farms to major agribusinesses and power producers.
2525

@@ -62,7 +62,7 @@ Arbol builds its data indexes by drawing on large weather-related datasets from
6262

6363
Arbol's business model hinges upon the benefits afforded by IPFS — without its immutable content addressing and inherent data verifiability, the benefits Arbol provides would be impossible to achieve in a cost-effective and efficient way. As a whole, IPFS is critical to Arbol's service model by providing the following:
6464

65-
- **Immutable addressing:** Because all data stored using IPFS is referenced and accessed via unique [content identifiers (CIDs)](content-addressing.md), any change to a data item means it receives a new CID exclusive to that revision. It's impossible to change data without changing its CID.
65+
- **Immutable addressing:** Because all data stored using IPFS is referenced and accessed via unique [content identifiers (CIDs)](../concepts/content-addressing.md), any change to a data item means it receives a new CID exclusive to that revision. It's impossible to change data without changing its CID.
6666

6767
- **Data verifiability:** Contracts on Arbol's platform are linked to specific, verifiably unchanged, content-addressed data. Because parametric weather risk management absolutely relies on user agreement about and trust in source data, Arbol's approach offers reassurance unavailable with other offerings in the market.
6868

@@ -86,13 +86,13 @@ Arbol's end users enjoy the "it just works" benefits of parametric protection, b
8686

8787
7. **Publishing:** Once a hash has been verified, it is posted to Arbol's master heads reference file, and is at this point accessible via Arbol's gateway and available for use in contracts.
8888

89-
8. **Pinning and syncing:** When storage nodes in the Arbol network detect that a new hash has been added to the heads file, they run the standard, recursive [`ipfs pin -r`](../reference/kubo/cli.md#ipfs-pin) command on it. Arbol's primary active nodes don't need to be large in number: The network includes a single [gateway node](ipfs-gateway.md) that bootstraps with all the parsing/hashing nodes, and a few large storage nodes that serve as the primary data storage backup. However, data is also regularly synced with "cold nodes" — archival storage nodes that are mostly kept offline — as well as on individual IPFS nodes on Arbol's developers' and agronomists' personal computers.
89+
8. **Pinning and syncing:** When storage nodes in the Arbol network detect that a new hash has been added to the heads file, they run the standard, recursive [`ipfs pin -r`](../reference/kubo/cli.md#ipfs-pin) command on it. Arbol's primary active nodes don't need to be large in number: The network includes a single [gateway node](../concepts/ipfs-gateway.md) that bootstraps with all the parsing/hashing nodes, and a few large storage nodes that serve as the primary data storage backup. However, data is also regularly synced with "cold nodes" — archival storage nodes that are mostly kept offline — as well as on individual IPFS nodes on Arbol's developers' and agronomists' personal computers.
9090

91-
9. **Garbage collection:** Some older Arbol datasets require [garbage collection](glossary.md#garbage-collection) whenever new data is added, due to a legacy method of overwriting old hashes with new hashes. However, all of Arbol's newer datasets use an architecture where old hashes are preserved and new posts reference the previous post. This methodology creates a linked list of hashes, with each hash containing a reference to the previous hash. As the length of the list becomes computationally burdensome, the system consolidates intermediate nodes and adds a new route to the head, creating a [DAG (directed acyclic graph)](merkle-dag.md) structure. Heads are always stored in a master [heads.json reference file](https://gateway.arbolmarket.com/climate/hashes/heads.json) located on Arbol's command server.
91+
9. **Garbage collection:** Some older Arbol datasets require [garbage collection](../concepts/glossary.md#garbage-collection) whenever new data is added, due to a legacy method of overwriting old hashes with new hashes. However, all of Arbol's newer datasets use an architecture where old hashes are preserved and new posts reference the previous post. This methodology creates a linked list of hashes, with each hash containing a reference to the previous hash. As the length of the list becomes computationally burdensome, the system consolidates intermediate nodes and adds a new route to the head, creating a [DAG (directed acyclic graph)](../concepts/merkle-dag.md) structure. Heads are always stored in a master [heads.json reference file](https://gateway.arbolmarket.com/climate/hashes/heads.json) located on Arbol's command server.
9292

9393
### The tooling
9494

95-
![Arbol high-level architecture](./images/case-studies/img-arbol-arch.svg)
95+
![Arbol high-level architecture](./images/img-arbol-arch.svg)
9696

9797
In addition to out-of-the-box [`kubo`](https://github.com/ipfs/kubo), Arbol relies heavily on custom written libraries and a number of weather-specialized Python libraries such as [netCDF4](https://pypi.org/project/netCDF4/) (an interface to netCDF, a self-describing format for array-oriented data) and [rasterio](https://pypi.org/project/rasterio) (for geospatial raster data). Additionally, Docker and Digital Ocean are important tools in Arbol's box for continuous integration and deployment.
9898

@@ -120,4 +120,4 @@ Another exciting future initiative is the open sourcing and expansion of the int
120120
_&mdash; Ben Andre, CTO, Arbol_
121121
:::
122122

123-
_Note: Metrics and other details in this case study are current as of September 2020. Details may change in the interim._
123+
_Note: Metrics and other details in this case study are current as of September 2020. Details may change in the interim._

docs/concepts/case-study-audius.md renamed to docs/case-studies/audius.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ _&mdash; Hareesh Nagaraj, Senior Engineer, Audius_
1818
## Overview
1919

2020
::: right
21-
<img src="./images/case-studies/logo-audius.png" alt="Audius logo" width="100">
21+
<img src="./images/logo-audius.png" alt="Audius logo" width="100">
2222
:::
2323

2424
**[Audius](https://audius.co/)** is a music and audio sharing platform designed to provide artists a direct link with their listeners. Using decentralized technology, Audius is able to ensure artists’ rights to and control of their own music, and provide a censorship-resistant platform for expression and distribution of artistic works and compositions. To create a user-owned and operated platform, it was key to have a distributed cloud storage network as the basis for the system. Audius uses IPFS as the core decentralized storage component in their mission to give everyone the freedom to share, monetize and listen to any audio.
@@ -119,4 +119,4 @@ Audius is looking forward to an upcoming version release with additional metrics
119119

120120
Other longer-term plans include creating multiple storage locations for faster streaming of content, as well as decreasing latency. Content encryption is also on the roadmap.
121121

122-
_Note: Metrics and other details in this case study are current as of July 2020. Details may change in the interim._
122+
_Note: Metrics and other details in this case study are current as of July 2020. Details may change in the interim._

docs/concepts/case-study-fleek.md renamed to docs/case-studies/fleek.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ _&mdash; Brett Shear, COO, Fleek_
1414
## Overview
1515

1616
::: right
17-
<img src="./images/case-studies/logo-fleek.png" alt="Fleek logo" width="200">
17+
<img src="./images/logo-fleek.png" alt="Fleek logo" width="200">
1818
:::
1919

2020
[Fleek](https://fleek.co/) is an easy-to-use service for hosting websites, storing and delivering files, and developing apps for the decentralized web (DWeb). As the next generation of the internet, the DWeb offers massive strides forward in terms of data autonomy, disaster and censorship resilience, performance, and speed — but for those who aren't yet familiar with it, using or building for the decentralized web can be time-consuming or difficult. Fleek's mission is to speed adoption of the DWeb by making it easier for everyone from dedicated developers to everyday internet users to create apps and store files in a decentralized paradigm, positioning them on the vanguard of a "low-code/no-code" movement of platforms, services, and development tools for users at all levels of coding experience.
@@ -62,7 +62,7 @@ In short, Fleek's portfolio offers wide-ranging functionality and a bridge betwe
6262

6363
Fleek chose IPFS because it decentralizes two of the core aspects of the internet: file storage and data transfer. Combined with the inherent advantages of IPFS content addressing and IPFS's position as a fundamental technology in Filecoin, this opens up a host of benefits not available elsewhere:
6464

65-
- **Data integrity in a peer-to-peer world:** Fleek uses IPFS in combination with encryption tools like Textile's, enabling them to offer a best-of-both-worlds paradigm where users get the benefits of client-side encryption (through user-owned keys) as well as the ability to share data directly without touching any third-party servers. Because the transport is encrypted by default, external watchers can't view it in transit, and IPFS's [content addressing](content-addressing.md) also ensures that the data a user receives when they make a request is cryptographically verified as the data they asked for.
65+
- **Data integrity in a peer-to-peer world:** Fleek uses IPFS in combination with encryption tools like Textile's, enabling them to offer a best-of-both-worlds paradigm where users get the benefits of client-side encryption (through user-owned keys) as well as the ability to share data directly without touching any third-party servers. Because the transport is encrypted by default, external watchers can't view it in transit, and IPFS's [content addressing](../concepts/content-addressing.md) also ensures that the data a user receives when they make a request is cryptographically verified as the data they asked for.
6666
- **Censorship and disaster resilience:** IPFS content addressing allows for multiple copies of the same content-addressed resource to exist as equivalent items in multiple locations worldwide. This can offer the potential for a degree of resilience against physical disaster or censorship unavailable on the legacy web.
6767
- **Integrated access to future storage and retrieval markets:** Because IPFS and Filecoin are so tightly integrated, building on IPFS will facilitate the ability to offer Fleek users a seamless way to access the Filecoin marketplace for their storage needs.
6868

@@ -133,4 +133,4 @@ Fleek is also looking forward to the implementation of IPFS in-browser connectiv
133133

134134
Finally, Fleek is currently working on integrating Filecoin payment options and storage on the Filecoin network into the Space Daemon, unlocking a world of possibility for Space Daemon developers wanting to use Filecoin to solve their storage needs.
135135

136-
_Note: Metrics and other details in this case study are current as of September 2020. Details may change in the interim._
136+
_Note: Metrics and other details in this case study are current as of September 2020. Details may change in the interim._

0 commit comments

Comments
 (0)