Merge pull request #10 from ipfs/feat-migration-tweaks-3

Migrate all the things

Author: jessicaschilling

docs/.vuepress/config.js

@@ -65,7 +65,7 @@ module.exports = {
                 collapsable: false,
                 children: [
                   '/essentials/dht',
-                  '/essentials/merkle-dags',
+                  '/essentials/merkle-dag',
                   '/essentials/bitswap',
                   '/essentials/ipld',
                   '/essentials/ipns',
@@ -83,21 +83,21 @@ module.exports = {
           },
           {
             title: 'How-tos',
-            path: '/how-tos/',
+            path: '/how-to/',
             children: [
               {
                 title: 'Quick start',
                 sidebarDepth: 1,
                 collapsable: false,
-                children: ['/how-tos/command-line-quick-start']
+                children: ['/how-to/command-line-quick-start']
               },
               {
                 title: 'Customize your install',
                 sidebarDepth: 1,
                 collapsable: false,
                 children: [
-                  '/how-tos/configure-node',
-                  '/how-tos/modify-peers-list',
+                  '/how-to/configure-node',
+                  '/how-to/modify-bootstrap-list',
                   [
                     'https://github.com/ipfs/js-ipfs/tree/master/examples/custom-ipfs-repo',
                     'Customize an IPFS repo'
@@ -117,8 +117,8 @@ module.exports = {
                     'https://github.com/ipfs/go-ipfs/tree/master/docs/examples/go-ipfs-as-a-library/README.md',
                     'Use go-ipfs as a library'
                   ],
-                  '/how-tos/work-with-blocks',
-                  '/how-tos/pin-files',
+                  '/how-to/work-with-blocks',
+                  '/how-to/pin-files',
                   [
                     'https://github.com/ipfs/go-ipfs/blob/master/docs/file-transfer.md',
                     'Troubleshoot file transfers'
@@ -127,9 +127,9 @@ module.exports = {
                     'https://github.com/ipfs/js-ipfs/blob/master/examples/traverse-ipld-graphs',
                     'Traverse IPLD graphs'
                   ],
-                  '/how-tos/take-snapshot',
-                  '/how-tos/store-play-videos',
-                  '/how-tos/host-git-style-repo',
+                  '/how-to/take-snapshot',
+                  '/how-to/store-play-videos',
+                  '/how-to/host-git-style-repo',
                   [
                     'https://github.com/ipfs/archives/tree/master/tutorials/replicating-large-datasets',
                     'Replicate large datasets'
@@ -141,7 +141,7 @@ module.exports = {
                 sidebarDepth: 1,
                 collapsable: false,
                 children: [
-                  '/how-tos/observe-peers',
+                  '/how-to/observe-peers',
                   [
                     'https://github.com/ipfs/js-ipfs/blob/master/examples/custom-libp2p',
                     'Customize libp2p bundles'
@@ -156,7 +156,7 @@ module.exports = {
                 title: 'Host websites',
                 sidebarDepth: 1,
                 collapsable: false,
-                children: ['/how-tos/host-single-page-site']
+                children: ['/how-to/host-single-page-site']
               },
               {
                 title: 'Work with blockchains',
@@ -174,7 +174,7 @@ module.exports = {
                 sidebarDepth: 1,
                 collapsable: false,
                 children: [
-                  '/how-tos/make-service',
+                  '/how-to/make-service',
                   [
                     'https://github.com/ipfs/camp/tree/master/CORE_AND_ELECTIVE_COURSES/CORE_COURSE_C',
                     'Build with the IPFS API'
@@ -190,7 +190,7 @@ module.exports = {
                 sidebarDepth: 1,
                 collapsable: false,
                 children: [
-                  'how-tos/address-ipfs-on-web',
+                  'how-to/address-ipfs-on-web',
                   [
                     'https://github.com/ipfs/js-ipfs/blob/master/examples/exchange-files-in-browser',
                     'Exchange files between nodes'
@@ -215,7 +215,7 @@ module.exports = {
                     'https://github.com/ipfs/js-ipfs/blob/master/examples/browser-readablestream',
                     'Stream video'
                   ],
-                  '/how-tos/browser-tools-frameworks'
+                  '/how-to/browser-tools-frameworks'
                 ]
               }
             ]
@@ -224,8 +224,8 @@ module.exports = {
             title: 'API & CLI',
             path: '/reference/',
             children: [
-              '/reference/js/api',
               '/reference/go/api',
+              '/reference/js/api',
               '/reference/http/api',
               '/reference/cli'
             ]

docs/README.md

@@ -2,62 +2,34 @@
 title: IPFS Documentation
 ---
 
-# IPFS documentation
+# IPFS Documentation
 
-::: warning
-This draft content ported from the legacy docs site may contain broken links and other errors. (Please remove this alert once content has been reviewed.)
-:::
+**Welcome to IPFS!** We're glad you're here, and we hope this documentation site will help you make the decentralized Internet a better place for humanity. Whether you’re just learning about IPFS or are looking for detailed reference information, here's where to start.
 
-Welcome to the IPFS documentation portal! Whether you’re just learning about IPFS or are looking for detailed reference information, this is the place to start. You might have noticed that IPFS is a project with a big scope — and a _lot_ of different tools, sites, and code.
+IPFS docs are organized into the following main categories:
 
-Here’s an overview of what you’ll find in our documentation:
+## Install IPFS
 
-## Introduction
+[Here's your guide](/install/) if you just want to install IPFS and get started right away!
 
-Head over to the [introduction](/introduction) section to learn about the basics of IPFS. There are also instructions on how to install IPFS, and tips on basic IPFS usage.
+## Essentials
 
-## Guides
+[Check out these IPFS essentials](/essentials/) if you're new to IPFS or the distributed web in general. Because IPFS is a system that hopes to change how we use the Internet, it comes with many new concepts! This section aims to get you up to speed quickly.
 
-IPFS is a system that hopes to change how we use the internet, so it comes with many new concepts. The guides section has an overview of major [concepts](/guides/concepts) in IPFS (including terms and ideas associated with distributed file systems generally), guides for specific IPFS use cases, and example projects demonstrating various ways to use the IPFS ecosystem.
+## How-tos
 
-For detailed guidance on select topics, try out the interactive tutorials at [ProtoSchool](https://proto.school). You can learn about the decentralized web by solving code challenges.
+[Our how-tos and tutorials](/how-to/) offer more in-depth advice and information on IPFS specifics from customizing your install to managing files, working with peers, building apps, and more.
 
-## Reference
+Also, check out [ProtoSchool](https://www.proto.school) for interactive tutorials on decentralized web concepts, protocols, and tools that you can complete right in your browser!
 
-### Commands & API
+## API & CLI reference
 
-If you are using IPFS via the [command line](/reference/api/cli) or [interacting with a running IPFS node](/reference/api/http) programmatically, you’ll use IPFS’s commands API. It’s implemented in both the Go and JavaScript versions of IPFS.
+[Find developer references](/reference/) to help you get things done — whether you're using IPFS via the command line, interacting with IPFS nodes using HTTP, or creating your own new applications on top of IPFS using Go or JavaScript.
 
-### Go & JavaScript Implementations
+## Support & community
 
-IPFS is fundamentally a set of protocols for communicating about a distributed system of files, but those protocols are informed by reference implementations in both [Go](/reference/go/overview) and [JavaScript](/reference/js/overview). The Go implementation is more mature and implements more of the IPFS protocols, but the JS implementation can be used in a broader variety of requirements (including in web browsers).
+[Get support or just get together](/support-community/) with IPFS developers and enthusiasts all over the globe. Here's where to find the IPFS community in forums, in person, on social media, and more.
 
-### Specifications & Planning
+## The IPFS project
 
-While IPFS has two reference implementations (in Go and JavaScript), it is fundamentally a set of protocols for formatting and communicating about distributed file systems. You can find specifications for those protocols, whitepapers, and information about our RFC (Request for Change) process in the “specifications & planning” section.
-
-## Community
-
-Get in touch with other members of the IPFS community who are building tools on top of IPFS or even helping to build IPFS itself! You can ask questions, discuss new ideas, or get support for problems at https://discuss.ipfs.io, but you can also [hop on IRC](/community/irc) for a quick chat.
-
-See the other links in the community section for more information about meetings, events, apps people are building, and more.
-
-Information about contributing to IPFS and about other software projects in the community are also hosted here.
-
-### Applications
-
-Both the Go and JavaScript implementations of IPFS are written to function as libraries and command-line applications with relatively restricted functionality. We are working on a variety of other applications that make use of IPFS, like GUI applications, browser extensions, and clustering tools for managing large data archives. You can find more about them here.
-
-### Get Involved
-
-IPFS is an open-source community project. While [Protocol Labs](https://protocol.ai) is able to sponsor some of the work around it, much of the design, code, and effort is contributed by volunteers and community members like you. If you’re interested in helping improve IPFS, check the [how to help](/community/contribute/how-to-help) guide to get started.
-
-If you are diving in to contribute new code, make sure you check both the [contribution guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) and the style guide for your language ([Go](https://github.com/ipfs/community/blob/master/CONTRIBUTING_GO.md), [JavaScript](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)).
-
-### Related Projects
-
-We’ve split out some of the major parts of IPFS into separate projects over time — while they’re still critical components of IPFS, they can be useful in a variety of other contexts, too. Check their individual sites for specific information and references:
-
-- [Libp2p](https://libp2p.io) manages all the peer-to-peer networking parts of IPFS.
-- [Multiformats](https://multiformats.io) is a variety of _self-describing_ data formats.
-- [IPLD](https://ipld.io) is a set of tools for describing links between content-addressed data, like IPFS files, Git commits, or Ethereum blocks.
+[Learn all about the IPFS project](/project/), including its history, current state, specifications, and future trajectory — plus, find everything you need to know in order to join the thousands of IPFS contributors from around the world!

docs/essentials/README.md

@@ -4,8 +4,46 @@ title: Essentials
 
 # IPFS essentials
 
-::: warning
-This draft content ported from the legacy docs site may contain broken links and other errors. (Please remove this alert once content has been reviewed.)
-:::
+New to IPFS or the distributed web? Here's where to get started on understanding the key ingredients in what makes IPFS work. Because IPFS is a system that hopes to change how we use the Internet, it comes with many new concepts! This section aims to get you up to speed quickly.
 
-You get to this main page when you click on the highest-level nav. What goes here?
+## IPFS in a nutshell
+
+Get the basic concepts of IPFS in one place, including:
+
+- [What is IPFS?](/essentials/what-is-ipfs/)
+- [How IPFS works](/essentials/how-ipfs-works/)
+- [Usage ideas & examples](/essentials/usage-ideas-examples/)
+- [Glossary](/essentials/glossary/)
+- [FAQ](/essentials/faq/)
+
+## Content-addressed storage
+
+Referring to files by their content, not their location, is one of the most powerful concepts within IPFS. Learn why with explainers on:
+
+- [Content addressing](/essentials/content-addressing/)
+- [Cryptographic hashing](/essentials/hashing/)
+- [Immutability](/essentials/immutability/)
+- [Persistence, permancence and pinning](/essentials/persistence/)
+
+## Peer-to-peer file sharing
+
+Sharing files between peers is incredibly powerful — and has many nuances! Learn about file-sharing paradigms and tools:
+
+- [Distributed Hash Tables (DHTs)](/essentials/dht/)
+- [Merkle DAGs](/essentials/merkle-dag/)
+- [Bitswap](/essentials/bitswap/)
+- [IPLD](/essentials/ipld/)
+- [IPNS](/essentials/ipns/)
+- [libp2p](/essentials/libp2p/)
+- [File systems](/essentials/file-systems/)
+
+## Integrating IPFS and the existing Web
+
+IPFS aims to be the future of the internet, but it still needs to play well with today's Web. Here are some ways to do just that:
+
+- [IPFS Gateway](/essentials/ipfs-gateway/)
+- [DNSLink](/essentials/dnslink/)
+
+## Don't see what you're looking for?
+
+We're adding more documentation all the time and making ongoing revisions to existing docs, but if you don't see what you need, please [file an issue](https://github.com/ipfs/docs/issues/new?assignees=&labels=OKR+3%3A+Content+Improvement%2C+docs-ipfs&template=content-request.md&title=%5BCONTENT+REQUEST%5D+%28add+your+title+here%21%29) to let us know! We also recommend visiting the [IPFS forums](https://discuss.ipfs.io/) for support and discussion with IPFS enthusiasts and experts worldwide.

docs/essentials/bitswap.md

@@ -5,4 +5,4 @@ sidebarDepth: 0
 
 # Bitswap
 
-## Sorry, this content hasn't touched down yet.
+## This content is still preparing for liftoff.

docs/essentials/faq.md

@@ -22,7 +22,7 @@ To learn more, see the [“what is IPFS?”](/essentials/what-is-ipfs) guide.
 
 The quickest way to get IPFS up and running on your machine is by installing [IPFS Desktop](https://github.com/ipfs-shipyard/ipfs-desktop), the easy-to-use app that enables you to run an IPFS node on your computer without having to bother with terminal commands.
 
-For installing and initializing IPFS from the command line, check out the [command-line quick start](/how-tos/command-line-quick-start/) guide.
+For installing and initializing IPFS from the command line, check out the [command-line quick start](/how-to/command-line-quick-start/) guide.
 
 ## Contributing to IPFS
 

docs/essentials/glossary.md

@@ -5,4 +5,4 @@ sidebarDepth: 0
 
 # IPFS Glossary
 
-## Sorry, this content hasn't touched down yet.
+## This content is still preparing for liftoff.