Skip to content

Commit 33529cc

Browse files
lidel2color
andauthored
chore: cleanup outdated services and old links (#2108)
* chore: cleanup outdated services and old links Updated pinning service documentation: - Removed outdated web3.storage references from quickstart guides - Added current pinning services: Storacha, Pinata, and Filebase - Split /quickstart/publish.md and /quickstart/publish_cli.md into distinct GUI-focused and CLI-focused guides - Removed unused web3.storage screenshots Fixed outdated references: - Updated Accelerated DHT Client links from experimental features to current config documentation - Removed unnecessary "go-ipfs" references (now just "Kubo") Improved main install page: - Added "Publish files with a pinning service" section for easy onboarding Files modified - docs/quickstart/publish.md - Focus on web/GUI interfaces - docs/quickstart/publish_cli.md - Focus on CLI/API methods - docs/install/README.md - Added pinning section, minor fixes - docs/how-to/gateway-best-practices.md - Updated DHT client link - docs/how-to/troubleshooting.md - Updated DHT client link - docs/install/command-line.md - Removed "(go-ipfs)" reference - docs/reference/go/api.md - Cleaned up Kubo reference Files removed - docs/quickstart/images/ - Removed 6 unused web3.storage screenshots * chore: web3.storage → storacha * chore: side menu + rename publish → pin #2108 (comment) * docs: mention self-hosting options * chore: fix lint / possesive forms * fix: broken/outdated links * docs: glossary items * fix: commas * Update docs/.vuepress/config.js Co-authored-by: Daniel Norman <[email protected]> * Update docs/.vuepress/config.js Co-authored-by: Daniel Norman <[email protected]> * Update docs/.vuepress/config.js Co-authored-by: Daniel Norman <[email protected]> * Update docs/.vuepress/config.js Co-authored-by: Daniel Norman <[email protected]> * fix: update pinata api docs link to working url --------- Co-authored-by: Daniel Norman <[email protected]>
1 parent 2e7ca28 commit 33529cc

21 files changed

+391
-259
lines changed

.github/styles/pln-ignore.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ atcute
1515
auditable
1616
audius
1717
auspinner
18+
Bacalhau
1819
bitswap
1920
bit[ss]wap
2021
blockchain
@@ -82,6 +83,7 @@ explainers
8283
fabien
8384
failovers
8485
filebase
86+
Filebase's
8587
filecoin
8688
filecorgi
8789
filesizes
@@ -230,6 +232,7 @@ runtime's
230232
sandboxed
231233
satoshi
232234
satoshi nakamoto
235+
SDKs
233236
serverless
234237
sharding
235238
snapshotted
@@ -240,6 +243,7 @@ someguy
240243
stackparse
241244
stdout
242245
storacha
246+
Storacha's
243247
storj
244248
subcommand
245249
substring

docs/.vuepress/config.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,9 @@ module.exports = {
105105
sidebarDepth: 1,
106106
collapsable: false,
107107
children: [
108-
['/quickstart/retrieve','Retrieve with IPFS'],
108+
['/quickstart/retrieve','Retrieve from IPFS'],
109+
['/quickstart/pin','Pin (Browser)'],
110+
['/quickstart/pin-cli','Pin (CLI)'],
109111
['/how-to/websites-on-ipfs/deploy-github-action', 'Deploy to IPFS with GitHub Actions' ],
110112
]
111113
},
@@ -123,7 +125,9 @@ module.exports = {
123125
sidebarDepth: 1,
124126
collapsable: false,
125127
children: [
126-
['/quickstart/retrieve','Retrieve with IPFS'],
128+
['/quickstart/retrieve','Retrieve from IPFS'],
129+
['/quickstart/pin','Pin (Browser)'],
130+
['/quickstart/pin-cli','Pin (CLI)'],
127131
['/how-to/websites-on-ipfs/deploy-github-action', 'Deploy to IPFS with GitHub Actions' ],
128132

129133
]

docs/.vuepress/redirects

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,5 @@
7777
/reference/api/http/ /reference/http/api
7878
/reference/go/overview/ /reference/go/api
7979
/reference/js/overview/ /reference/js/api
80+
/quickstart/publish /quickstart/pin
81+
/quickstart/publish_cli /quickstart/pin-cli

docs/concepts/cod.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ Bacalhau can:
2929

3030
### More Bacalhau resources
3131

32-
- [Getting started tutorial](https://docs.bacalhau.org/getting-started/installation/)
33-
- [Bacalhau platform architecture](https://docs.bacalhau.org/getting-started/architecture/)
32+
- [Bacalhau documentation](https://docs.bacalhau.org/)
3433
- [GitHub](https://github.com/bacalhau-project/bacalhau)
3534

3635
## IPVM
@@ -39,7 +38,7 @@ The InterPlanetary Virtual Machine (IPVM) specification defines the easiest, fas
3938

4039
IPVM uses [WebAssembly (Wasm)](https://webassembly.org/), content addressing, [simple public key infrastructure (SPKI)](https://en.wikipedia.org/wiki/Simple_public-key_infrastructure), and object capabilities to liberate computation from specific, prenegotiated services, such as large cloud computing providers. By default, execution scales flexibly on-device, all the way up to edge points-of-presence (PoPs) and data centers.
4140

42-
The core, Rust-based implementation and runtime of IPVM is the [Homestar project](https://github.com/ipvm-wg/homestar/). IPVM supports interoperability with [Bacalhau](https://bacalhau.org) and [Web3Storage](https://web3.storage/)
41+
The core, Rust-based implementation and runtime of IPVM is the [Homestar project](https://github.com/ipvm-wg/homestar/). IPVM supports interoperability with [Bacalhau](https://bacalhau.org) and [Storacha (formerly web3.storage)](https://storacha.network/)
4342

4443
### More IPVM resources
4544

docs/concepts/glossary.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,10 @@ A Peer ID is how each unique IPFS node is identified on the network. The Peer ID
398398

399399
Pinning is the method of telling an IPFS node that particular data is important and so it will never be removed from that node's cache. To learn more, start by understanding [persistence, permanence, and pinning](persistence.md); then, see how to [add local pin](../how-to/pin-files.md) and read [what remote pins are](#remote-pinning).
400400

401+
### Pinning service
402+
403+
Third-party services that run IPFS nodes and [pin](#pinning) content on behalf of users, ensuring data remains available on the IPFS network even when the user's local node is offline. See [working with pinning services](../how-to/work-with-pinning-services.md).
404+
401405
### Pinning Service API
402406

403407
A vendor-agnostic [API specification](https://ipfs.github.io/pinning-services-api-spec/) that anyone can implement to provide a service for [remote pinning](#remote-pinning).
@@ -422,6 +426,10 @@ QUIC (`/quic-v1`) is one of [libp2p](#libp2p) [transport](#transport) protocols.
422426

423427
## R
424428

429+
### Redundancy
430+
431+
In IPFS context, the practice of [pinning](#pinning) the same content to multiple nodes or [pinning services](#pinning-service) to ensure availability even if one source goes offline. This increases the resilience and availability of data on the [network](#mainnet).
432+
425433
### Relay node
426434

427435
A means to establish connectivity between libp2p nodes (e.g., IPFS nodes) that wouldn't otherwise be able to establish a direct connection to each other. This may be due to nodes that are behind NAT (Network Address Translation), reverse proxies, firewalls, etc. See [Nodes > Relay](../concepts/nodes.md#relay) and [libp2p docs about Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/).
@@ -458,6 +466,10 @@ In IPFS, IPLD Schemas are a system for describing data with structural types. [M
458466

459467
IPLD selectors are a form of graph query over IPLD data. They can also be thought of as a way to specify a [traversal](#traversal). [More about IPLD Selectors](https://ipld.io/glossary/#selectors)
460468

469+
### Self-hosting
470+
471+
Running your own IPFS node (using [Kubo](#kubo), [IPFS Desktop](#ipfs-desktop), or other implementations) to [pin](#pinning) and serve content, as opposed to relying solely on third-party [pinning services](#pinning-service). Self-hosting gives you full control over your data while participating in the IPFS network.
472+
461473
### SFS
462474

463475
A Self-certifying File System (SFS) is a distributed file system that doesn't require special permissions for data exchange. It is self-certifying because data served to a client is authenticated by the file name (which is signed by the server). [More about SFS](https://en.wikipedia.org/wiki/Self-certifying_File_System)

docs/concepts/persistence.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Some of the pinning services listed below are operated by third party companies.
5151
- [NFT.Storage](https://nft.storage/)
5252
- [Pinata](https://pinata.cloud/)
5353
- [Scaleway](https://labs.scaleway.com/en/ipfs-pinning/)
54-
- [Web3.Storage](https://web3.storage/)
54+
- [Storacha (formerly web3.storage)](https://storacha.network/)
5555

5656
See how to [work with remote pinning services](../how-to/work-with-pinning-services.md).
5757

docs/how-to/gateway-best-practices.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn best practices for working with IPFS HTTP Gateways
55

66
# Best practices for HTTP Gateways
77

8-
Various best practices for the use of IPFS gateways are listed below. To learn more about the concepts behind IPFS gateways, including how they work, available providers, types and FAQs, see [IPFS Gateway](../concepts/ipfs-gateway.md). For troubleshooting information, see [Troubleshooting](./gateway-troubleshooting.md).
8+
Various best practices for the use of IPFS gateways are listed below. To learn more about the concepts behind IPFS gateways, including how they work, available providers, types and FAQs, see [IPFS Gateway](../concepts/ipfs-gateway.md). For troubleshooting information, see [Troubleshooting](./troubleshooting.md).
99

1010
## Selecting a gateway type to use
1111

@@ -33,7 +33,7 @@ If you are running an IPFS node that is also configured as an IPFS gateway, each
3333
- If your node is not reachable because you are behind NAT, see the [NAT configuration](https://docs.ipfs.tech/how-to/nat-configuration/#ipv6) docs.
3434
- Ensure that you are correctly returning HTTP cache headers to the client if the IPFS gateway node is behind a reverse proxy. Pay extra attention to `Etag`, `Cache-Control`, and `Last-Modified headers`. Consider leveraging the list of CIDs in `X-Ipfs-Roots` for smarter HTTP caching strategies.
3535
- Put a CDN like Cloudflare in front of the IPFS gateway.
36-
- Consider enabling the [Accelerated DHT Client](https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md#accelerated-dht-client).
36+
- Consider enabling the [Accelerated DHT Client](https://github.com/ipfs/kubo/blob/master/docs/config.md#routingaccelerateddhtclient).
3737
- Test and monitor your internet connection speed, with a tool like [Speedtest CLI](https://www.speedtest.net/apps/cli).
3838
- Monitor disk I/O and make sure that no other processes are causing disk I/O bottlenecks with a tool like [iotop](https://github.com/Tomas-M/iotop) or [iostat](https://github.com/sysstat/sysstat).
3939

@@ -73,7 +73,7 @@ These pages do not share the same origin. Similarly, the use of DNSLink gateway
7373

7474
## Cross-origin resource sharing (CORS)
7575

76-
[CORS](https://web.archive.org/web/20200418003728/https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#The_HTTP_response_headers) allows a webpage to permit access to specified data by pages with a different origin. The [IPFS public gateway checker](https://ipfs.github.io/public-gateway-checker/) identifies those public gateways that support CORS.
76+
[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) allows a webpage to permit access to specified data by pages with a different origin. The [IPFS public gateway checker](https://ipfs.github.io/public-gateway-checker/) identifies those public gateways that support CORS.
7777

7878
## Gateway man-in-the-middle vulnerability
7979

docs/how-to/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ With this in mind, if no providers are returned, do the following:
257257

258258
2. Note the value for `LastReprovideDuration`. If it is close to 48 hours, or if you notice a "reprovide taking too long" warning in your `ipfs daemon` output log, select one of the following options, keeping in mind that each has tradeoffs:
259259

260-
- **Enable the [Accelerated DHT Client](https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md#accelerated-dht-client) in Kubo**. This configuration improves content providing times significantly by maintaining more connections to peers and a larger routing table and batching advertising of provider records. However, this performance boost comes at the cost of increased resource consumption, most notably network connections to other peers, and can lead to degraded network performance in home networks.
260+
- **Enable the [Accelerated DHT Client](https://github.com/ipfs/kubo/blob/master/docs/config.md#routingaccelerateddhtclient) in Kubo**. This configuration improves content providing times significantly by maintaining more connections to peers and a larger routing table and batching advertising of provider records. However, this performance boost comes at the cost of increased resource consumption, most notably network connections to other peers, and can lead to degraded network performance in home networks.
261261

262262
- **Change the [Reprovider Strategy](https://github.com/ipfs/kubo/blob/master/docs/config.md#reproviderstrategy) from `all` to either `pinned+mfs` or `roots`.** In both cases, only provider records for explicitly pinned content are advertised. Differences and tradeoffs are noted below:
263263
- The `pinned+mfs` strategy will advertise both the root CIDs and child block CIDs (the entire DAG) of explicitly pinned content and the locally available part of MFS.

docs/install/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ Anyone can use IPFS to store files in a _decentralized_ way. The easiest way to
1919

2020
If your browser doesn't support IPFS yet, you can install an IPFS companion extension that will let you view decentralized web content! [Learn more →](./ipfs-companion.md)
2121

22+
### Pin files with a pinning service
23+
24+
Do you want to quickly and easily publish content with IPFS without complex tools? See the [Pin with IPFS quickstart](../quickstart/pin.md), where you'll learn how to use third-party pinning services to pin and provide files to the IPFS network.
25+
2226
### Deploy static sites to the IPFS network with a GitHub Action
2327

2428
Do you want to quickly and easily automate the deployment of static websites to the IPFS network? See the [Deploy static sites to the IPFS network with GitHub Actions](../how-to/websites-on-ipfs/deploy-github-action.md), where you'll learn how to use [GitHub Actions](https://github.com/ipshipyard/ipfs-deploy-action) to automatically deploy static websites to the IPFS network.
@@ -53,7 +57,7 @@ To get started with a hands-on example, see [Helia 101](https://github.com/ipfs-
5357
If you are looking for simple [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)-like API for use on the web, see [@helia/verified-fetch](https://www.npmjs.com/package/@helia/verified-fetch).
5458
:::
5559

56-
### Boxo SDK for GO
60+
### Boxo SDK for Go
5761

5862
[Boxo](https://github.com/ipfs/boxo#readme) is a set of reference libraries for building IPFS applications and implementations in Go.
5963

docs/install/command-line.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ This reduces daemon overhead on the system but may degrade content discovery and
5555
This section describes how to download and install the Kubo binary from `dist.ipfs.tech` on Windows, MacOS, Linux, FreeBSD and OpenBSD operating systems. The IPFS team publishes the latest, official prebuilt Kubo binaries on the [dist.ipfs.tech website](https://dist.ipfs.tech#kubo). New IPFS Kubo binary releases are automatically shown on the Kubo page on `dist.ipfs.tech`.
5656

5757
:::callout
58-
If you are unable to access [dist.ipfs.tech](https://dist.ipfs.tech#kubo), you can also download Kubo (go-ipfs) from the project's GitHub [releases](https://github.com/ipfs/kubo/releases/latest) page or `/ipns/dist.ipfs.tech` at the [dweb.link](https://dweb.link/ipns/dist.ipfs.tech#kubo) gateway.
58+
If you are unable to access [dist.ipfs.tech](https://dist.ipfs.tech#kubo), you can also download Kubo from the project's GitHub [releases](https://github.com/ipfs/kubo/releases/latest) page or `/ipns/dist.ipfs.tech` at the [dweb.link](https://dweb.link/ipns/dist.ipfs.tech#kubo) gateway.
5959
:::
6060

6161
For installation instructions for your operating system, select the appropriate tab.

0 commit comments

Comments
 (0)