Description
This is part of ipfs/ipfs#470, read that first.
What
IPFS Stewards are renaming go-ipfs to something else ❄️
👉 Feel free to comment in ipfs/ipfs#471 with name (and logo like one in #8958).
Note: we reserve the right to ignore every instance of Boaty McBoatface.
Why
This is part of a wider, long ecosystem epic (see ipfs/ipfs#470) where we clarify that IPFS is a set of interoperable protocols and conventions, and not a specific implementation, like go-ipfs.
tl;dr:
- go-ipfs will stop squatting "IPFS" name
- we want to encourage people to create their own implementations
- makes it easier to think in terms of "IPFS protocol, libraries and specs" and "IPFS implementations" that are built with the former
When
This will take time, but we want to do the basic rename of project / repo (scope tbd) before July 2022
How
The scope is TBD, we are identifying potential breakage in #8958.
Current proposal is to:
🟢 Rename before July
- README and internal docs
- Git repo and
github.com/ipfs/go-ipfs/imports- Caveat: this will impact dist.ipfs.io artifact names. We want to limit the blast radius, so will be building dist under both new and old names, that way no external tooling built in the past 7 years will be broken. PoC in feat: dual publishing go-ipfs and kubo distributions#717
- https://ipfs.io/#install – PR: refactor: rename go-ipfs to Kubo ipfs-website#143
- https://docs.ipfs.io – PR: refactor: rename
go-ipfstokuboipfs-docs#1185 (waiting for 0.14)- ensure https://github.com/ipfs/ipfs-docs/tree/main/tools/http-api-docs automation works with the new repo name and the new name is listed on https://docs.ipfs.io/reference/http/api/
👍 👎 🤔 Need analysis and decision
- https://github.com/ipfs/go-ipfs-http-client – tracked in Point users at canonical kubo/client/rpc library #9124
- https://github.com/ipfs/go-ipfs-api – tracked in Point users at canonical kubo/client/rpc library #9124
- JS client library – Create js-kubo-rpc-client library #9125
🛑 Keep or rename at a later date
Things that use go-ipfs name, that we don't plan breaking at this time:
- keep old name at dist.ipfs.io (https://dist.ipfs.io/go-ipfs/ built in addition to the new name – PR in feat: dual publishing go-ipfs and kubo distributions#717)
- Docker (dual publishing)
- package at NPM (https://github.com/ipfs/npm-go-ipfs) – tracked in Rename NPM package to kubo npm-kubo#51
WANT TO PROPOSE THE NEW NAME?
👉 Feel free to comment in ipfs/ipfs#471 with name (and logo like one in #8958).