Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clean mentions of go-ipfs-api, go-ipfs-http-api #10176

Merged
merged 2 commits into from
Oct 13, 2023
Merged

Conversation

hacdias
Copy link
Member

@hacdias hacdias commented Oct 9, 2023

See #9124. This:

  1. Removes references to go-ipfs-api, which is now deprecated and archived.
  2. Points everywhere to kubo/client/rpc.
  3. Removes package-list.json, which was massively out of date and not being used anywhere. See also comment in Clean Kubo Client Story and Deprecated Packages ipfs-docs#1731 (comment).
  4. Removes CI check for go-ipfs-api.

@hacdias hacdias added the skip/changelog This change does NOT require a changelog entry label Oct 9, 2023
@hacdias hacdias requested review from BigLep and lidel October 9, 2023 09:18
@hacdias hacdias self-assigned this Oct 9, 2023
@hacdias hacdias requested a review from a team as a code owner October 9, 2023 09:18
Comment on lines -5 to -10
- [`js-kubo-rpc-client`](https://github.com/ipfs/js-kubo-rpc-client) - Official JS client for talking to Kubo RPC over HTTP
- [`go-ipfs-api`](https://github.com/ipfs/go-ipfs-api) - The go interface to ipfs's HTTP RPC - Follow https://github.com/ipfs/kubo/issues/9124 for coming changes.
- [`httpapi`](./client/rpc) (previously `go-ipfs-http-client`) - [`coreiface.CoreAPI`](https://pkg.go.dev/github.com/ipfs/boxo/coreiface#CoreAPI) implementation using HTTP RPC

## Recommended clients

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ Instead of duplicating information here, I think it is best to just remove the mention to go-ipfs-api. It exists, but let's not point people there.

@hacdias
Copy link
Member Author

hacdias commented Oct 13, 2023

I'm going ahead and merge this since go-ipfs-api is archived and this is mostly cosmetic changes already decided in #9124.

@hacdias hacdias enabled auto-merge (rebase) October 13, 2023 11:56
@hacdias hacdias disabled auto-merge October 13, 2023 11:57
@hacdias hacdias merged commit 40d459b into master Oct 13, 2023
17 checks passed
@hacdias hacdias deleted the docs-rpc-client branch October 13, 2023 11:57
@BigLep BigLep mentioned this pull request Nov 9, 2023
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip/changelog This change does NOT require a changelog entry
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant