diff --git a/docs/.vuepress/theme/components/LegacyCallout.vue b/docs/.vuepress/theme/components/LegacyCallout.vue new file mode 100644 index 000000000..c34552379 --- /dev/null +++ b/docs/.vuepress/theme/components/LegacyCallout.vue @@ -0,0 +1,44 @@ + + + + + diff --git a/docs/.vuepress/theme/global-components/LegacyCallout.vue b/docs/.vuepress/theme/global-components/LegacyCallout.vue new file mode 100644 index 000000000..a6e55c2c4 --- /dev/null +++ b/docs/.vuepress/theme/global-components/LegacyCallout.vue @@ -0,0 +1,65 @@ + + + + + diff --git a/docs/README.md b/docs/README.md index d976d0661..c4bdf8d1a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,6 @@ --- title: IPFS Documentation +legacyUrl: https://docs.ipfs.io/ --- # IPFS Documentation diff --git a/docs/community/README.md b/docs/community/README.md index 9befde159..4a73f11b0 100644 --- a/docs/community/README.md +++ b/docs/community/README.md @@ -1,5 +1,6 @@ --- title: Community +legacyUrl: https://docs.ipfs.io/community/ --- # Community diff --git a/docs/community/irc.md b/docs/community/irc.md index ab9cc809e..7e9f83190 100644 --- a/docs/community/irc.md +++ b/docs/community/irc.md @@ -1,5 +1,6 @@ --- title: IRC +legacyUrl: https://docs.ipfs.io/community/irc/ --- # Internet Relay Chat (IRC) diff --git a/docs/community/social-media.md b/docs/community/social-media.md index fd30075d7..0f527a623 100644 --- a/docs/community/social-media.md +++ b/docs/community/social-media.md @@ -1,6 +1,7 @@ --- title: Social media sidebarDepth: 0 +legacyUrl: https://docs.ipfs.io/community/ --- # Social media diff --git a/docs/concepts/README.md b/docs/concepts/README.md index 283af40db..78f591e59 100644 --- a/docs/concepts/README.md +++ b/docs/concepts/README.md @@ -1,5 +1,6 @@ --- title: Concepts +legacyUrl: https://docs.ipfs.io/guides/concepts/ --- # IPFS concepts diff --git a/docs/concepts/content-addressing.md b/docs/concepts/content-addressing.md index adf5dc396..3c4a9b88a 100644 --- a/docs/concepts/content-addressing.md +++ b/docs/concepts/content-addressing.md @@ -1,5 +1,6 @@ --- title: Content addressing +legacyUrl: https://docs.ipfs.io/guides/concepts/cid/ --- # Content addressing and CIDs diff --git a/docs/concepts/dht.md b/docs/concepts/dht.md index bc716ee1b..95e6b6259 100644 --- a/docs/concepts/dht.md +++ b/docs/concepts/dht.md @@ -1,5 +1,6 @@ --- title: Distributed Hash Tables (DHTs) +legacyUrl: https://docs.ipfs.io/guides/concepts/dht/ --- # Distributed Hash Tables (DHTs) diff --git a/docs/concepts/dnslink.md b/docs/concepts/dnslink.md index 3aeaa1539..6757e6ce1 100644 --- a/docs/concepts/dnslink.md +++ b/docs/concepts/dnslink.md @@ -1,5 +1,6 @@ --- title: DNSLink +legacyUrl: https://docs.ipfs.io/guides/concepts/dnslink/ --- # DNSLink diff --git a/docs/concepts/faq.md b/docs/concepts/faq.md index db91f7b3a..73a1ddc8c 100644 --- a/docs/concepts/faq.md +++ b/docs/concepts/faq.md @@ -1,5 +1,6 @@ --- title: FAQ +legacyUrl: https://docs.ipfs.io/introduction/faq/ --- # Frequently asked questions diff --git a/docs/concepts/file-systems.md b/docs/concepts/file-systems.md index 0640c0aff..2a2d70841 100644 --- a/docs/concepts/file-systems.md +++ b/docs/concepts/file-systems.md @@ -1,5 +1,6 @@ --- title: File systems +legacyUrl: https://docs.ipfs.io/guides/concepts/mfs/ --- # File systems and IPFS diff --git a/docs/concepts/hashing.md b/docs/concepts/hashing.md index ba249b3ca..c6bfd7be0 100644 --- a/docs/concepts/hashing.md +++ b/docs/concepts/hashing.md @@ -1,5 +1,6 @@ --- title: Hashing +legacyUrl: https://docs.ipfs.io/guides/concepts/hashes/ --- # Hashing diff --git a/docs/concepts/how-ipfs-works.md b/docs/concepts/how-ipfs-works.md index 4407879de..9ad7e1ba8 100644 --- a/docs/concepts/how-ipfs-works.md +++ b/docs/concepts/how-ipfs-works.md @@ -1,5 +1,6 @@ --- title: How IPFS works +legacyUrl: https://docs.ipfs.io/introduction/how-ipfs-works/ --- # How IPFS works diff --git a/docs/concepts/ipns.md b/docs/concepts/ipns.md index 095224f5f..74e1b4f39 100644 --- a/docs/concepts/ipns.md +++ b/docs/concepts/ipns.md @@ -1,5 +1,6 @@ --- title: IPNS +legacyUrl: https://docs.ipfs.io/guides/concepts/ipns/ --- # InterPlanetary Name System (IPNS) diff --git a/docs/concepts/merkle-dag.md b/docs/concepts/merkle-dag.md index e3af8a9f2..07de62941 100644 --- a/docs/concepts/merkle-dag.md +++ b/docs/concepts/merkle-dag.md @@ -1,5 +1,6 @@ --- title: Merkle DAGs +legacyUrl: https://docs.ipfs.io/guides/concepts/merkle-dag/ --- # Merkle Distributed Acyclic Graphs (DAGs) diff --git a/docs/concepts/persistence.md b/docs/concepts/persistence.md index f389cb82b..903def7bc 100644 --- a/docs/concepts/persistence.md +++ b/docs/concepts/persistence.md @@ -1,5 +1,6 @@ --- title: Persistence +legacyUrl: https://docs.ipfs.io/guides/concepts/pinning/ --- # Persistence, permanence and pinning diff --git a/docs/concepts/what-is-ipfs.md b/docs/concepts/what-is-ipfs.md index aa54e3e6a..6d27ce6f6 100644 --- a/docs/concepts/what-is-ipfs.md +++ b/docs/concepts/what-is-ipfs.md @@ -1,7 +1,10 @@ --- title: What is IPFS? +legacyUrl: https://docs.ipfs.io/introduction/overview/ --- +# What is IPFS? + Let's just start with a one-line definition of IPFS: **IPFS is a distributed system for storing and accessing files, websites, applications, and data.** diff --git a/docs/how-to/README.md b/docs/how-to/README.md index 843b6f73b..5858a5ff1 100644 --- a/docs/how-to/README.md +++ b/docs/how-to/README.md @@ -1,5 +1,6 @@ --- title: How-tos +legacyUrl: https://docs.ipfs.io/guides/examples/ --- # IPFS how-tos and tutorials diff --git a/docs/how-to/address-ipfs-on-web.md b/docs/how-to/address-ipfs-on-web.md index 32f9cafdd..e5f8017b7 100644 --- a/docs/how-to/address-ipfs-on-web.md +++ b/docs/how-to/address-ipfs-on-web.md @@ -1,5 +1,6 @@ --- title: Address IPFS on the Web +legacyUrl: https://docs.ipfs.io/guides/guides/addressing/ --- # Address IPFS on the Web diff --git a/docs/how-to/command-line-quick-start.md b/docs/how-to/command-line-quick-start.md index 628feafd5..7f30e4761 100644 --- a/docs/how-to/command-line-quick-start.md +++ b/docs/how-to/command-line-quick-start.md @@ -1,5 +1,6 @@ --- title: Command-line quick start +legacyUrl: https://docs.ipfs.io/introduction/usage/ --- # Command-line quick start diff --git a/docs/how-to/configure-node.md b/docs/how-to/configure-node.md index cc88c1ecb..e582215ab 100644 --- a/docs/how-to/configure-node.md +++ b/docs/how-to/configure-node.md @@ -1,5 +1,6 @@ --- title: Configure a node +legacyUrl: https://docs.ipfs.io/guides/examples/config/ --- # Configure a node diff --git a/docs/how-to/host-git-style-repo.md b/docs/how-to/host-git-style-repo.md index c57789f00..bae4a1c1f 100644 --- a/docs/how-to/host-git-style-repo.md +++ b/docs/how-to/host-git-style-repo.md @@ -1,5 +1,6 @@ --- title: Host a Git-style repo +legacyUrl: https://docs.ipfs.io/guides/examples/git/ --- # Host a Git-style repo diff --git a/docs/how-to/host-single-page-site.md b/docs/how-to/host-single-page-site.md index 41ad5da01..329013764 100644 --- a/docs/how-to/host-single-page-site.md +++ b/docs/how-to/host-single-page-site.md @@ -1,5 +1,6 @@ --- title: Host a single-page site +legacyUrl: https://docs.ipfs.io/guides/examples/websites/ --- # Host a single-page website diff --git a/docs/how-to/modify-bootstrap-list.md b/docs/how-to/modify-bootstrap-list.md index f9b76eecc..4bb26bda9 100644 --- a/docs/how-to/modify-bootstrap-list.md +++ b/docs/how-to/modify-bootstrap-list.md @@ -1,5 +1,6 @@ --- title: Modify the bootstrap list +legacyUrl: https://docs.ipfs.io/guides/examples/bootstrap/ --- # Modify the bootstrap peers list diff --git a/docs/how-to/observe-peers.md b/docs/how-to/observe-peers.md index 47c1a40a0..1ba8389b5 100644 --- a/docs/how-to/observe-peers.md +++ b/docs/how-to/observe-peers.md @@ -1,5 +1,6 @@ --- title: Observe peers +legacyUrl: https://docs.ipfs.io/guides/examples/network/ --- # Observe peers diff --git a/docs/how-to/pin-files.md b/docs/how-to/pin-files.md index 4c2f93d4c..1a292581d 100644 --- a/docs/how-to/pin-files.md +++ b/docs/how-to/pin-files.md @@ -1,5 +1,6 @@ --- title: Pin files +legacyUrl: https://docs.ipfs.io/guides/examples/pinning/ --- # Pin files using IPFS diff --git a/docs/how-to/store-play-videos.md b/docs/how-to/store-play-videos.md index 1d4ffaee5..1854eb4bb 100644 --- a/docs/how-to/store-play-videos.md +++ b/docs/how-to/store-play-videos.md @@ -1,5 +1,6 @@ --- title: Store & play videos +legacyUrl: https://docs.ipfs.io/guides/examples/videos/ --- # Store and play videos diff --git a/docs/how-to/take-snapshot.md b/docs/how-to/take-snapshot.md index 902139b26..5a39f0bdb 100644 --- a/docs/how-to/take-snapshot.md +++ b/docs/how-to/take-snapshot.md @@ -1,5 +1,6 @@ --- title: Take a snapshot +legacyUrl: https://docs.ipfs.io/guides/examples/snapshots/ --- # Take a snapshot diff --git a/docs/how-to/work-with-blocks.md b/docs/how-to/work-with-blocks.md index 593879ad0..c94f9bff8 100644 --- a/docs/how-to/work-with-blocks.md +++ b/docs/how-to/work-with-blocks.md @@ -1,5 +1,6 @@ --- title: Work with blocks +legacyUrl: https://docs.ipfs.io/guides/examples/blocks/ --- # Work with blocks diff --git a/docs/install/README.md b/docs/install/README.md index 526bac67e..0393ac83f 100644 --- a/docs/install/README.md +++ b/docs/install/README.md @@ -1,6 +1,7 @@ --- title: Install IPFS sidebarDepth: 0 +legacyUrl: https://docs.ipfs.io/introduction/usage/ --- # Install IPFS diff --git a/docs/project/contribute.md b/docs/project/contribute.md index 6887d3211..d44cff2cc 100644 --- a/docs/project/contribute.md +++ b/docs/project/contribute.md @@ -1,5 +1,6 @@ --- title: Contribute to IPFS +legacyUrl: https://docs.ipfs.io/community/contribute/how-to-help/ --- # Contribute to IPFS diff --git a/docs/reference/README.md b/docs/reference/README.md index 618e0ea2d..6296bb7d3 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -1,5 +1,6 @@ --- title: API & CLI +legacyUrl: https://docs.ipfs.io/reference/api/ --- # API & CLI reference diff --git a/docs/reference/cli.md b/docs/reference/cli.md index ddba45b63..90624e813 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -1,5 +1,6 @@ --- title: CLI commands +legacyUrl: https://docs.ipfs.io/reference/api/cli/ --- # Command-line interface (CLI) reference diff --git a/docs/reference/go/api.md b/docs/reference/go/api.md index 5c95a36b2..a162f9499 100644 --- a/docs/reference/go/api.md +++ b/docs/reference/go/api.md @@ -1,5 +1,6 @@ --- title: go-ipfs API +legacyUrl: https://docs.ipfs.io/reference/go/overview/ --- # API resources for go-ipfs diff --git a/docs/reference/http/api.md b/docs/reference/http/api.md index 428b7e906..d4227cf82 100644 --- a/docs/reference/http/api.md +++ b/docs/reference/http/api.md @@ -1,5 +1,6 @@ --- title: HTTP API +legacyUrl: https://docs.ipfs.io/reference/api/http/ --- # HTTP API reference @@ -88,12 +89,14 @@ flag is the `&encoding=json` query parameter below: ``` ## HTTP status codes + Status codes used at the RPC layer are simple: -* `500` - RPC endpoint returned an error -* `404` - RPC endpoint doesn't exist -* `400` - Malformed RPC, argument type error, etc -* `403` - RPC call forbidden -In other words, `500` means that the function _does_ exist, it just failed internally for some reason. To know that reason, you have to look at the "application layer" error (commands lib error). + +- `500` - RPC endpoint returned an error +- `404` - RPC endpoint doesn't exist +- `400` - Malformed RPC, argument type error, etc +- `403` - RPC call forbidden + In other words, `500` means that the function _does_ exist, it just failed internally for some reason. To know that reason, you have to look at the "application layer" error (commands lib error). ## HTTP commands @@ -3626,5 +3629,3 @@ On success, the call to this endpoint will return with 200 and the following bod ### cURL Example `curl "http://localhost:5001/api/v0/version/deps"` - - diff --git a/docs/reference/js/api.md b/docs/reference/js/api.md index 62832a320..384b1184a 100644 --- a/docs/reference/js/api.md +++ b/docs/reference/js/api.md @@ -1,5 +1,6 @@ --- title: js-ipfs API +legacyUrl: https://docs.ipfs.io/reference/js/ --- # API resources for js-ipfs