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: ipfs-http-client -> kubo-rpc-client #9331

Merged
merged 14 commits into from
Nov 22, 2022

Conversation

SgtPooki
Copy link
Member

@SgtPooki SgtPooki commented Oct 5, 2022

Tracking issue: ipfs/js-kubo-rpc-client#35
Parent issue: ipfs/js-kubo-rpc-client#6
Originating issue: #9125

This PR is intended to update the docs in ipfs/kubo so that users will be pointed to kubo-rpc-client instead of ipfs-http-client when using Javascript/TypeScript to talk to Kubo.

I noticed a lack in discussion about programmatic/api usage, so I modified more than may be expected, but I think it should be a significant improvement.

Keeping the list of http-clients up to date now involves only updating a single file in this repo. LMK if this is not desireable.

For other docs updates, follow ipfs/js-kubo-rpc-client#6

fixes ipfs/js-kubo-rpc-client#35

Things for reviewers to check:

  1. Confirm I didn't miss any areas that should be updated (old mentions that should be updated that aren't yet)
  2. Confirm the added information is accurate and desired
  3. Confirm that the language used is aligned with maintainers' intentions

@SgtPooki SgtPooki self-assigned this Oct 5, 2022
docs/http-clients.md Outdated Show resolved Hide resolved
docs/http-clients.md Outdated Show resolved Hide resolved
docs/http-clients.md Outdated Show resolved Hide resolved
docs/http-clients.md Outdated Show resolved Hide resolved
docs/http-clients.md Outdated Show resolved Hide resolved
@SgtPooki SgtPooki requested a review from BigLep October 13, 2022 17:15
lidel
lidel previously requested changes Oct 14, 2022
Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

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

Thanks @SgtPooki, in general avoid "HTTP API" (as we want Gateway to be that) and use "HTTP RPC" or even "HTTP RPC at /api/v0" to remove ambiguity 🙏

docs/http-rpc-clients.md Outdated Show resolved Hide resolved
docs/http-rpc-clients.md Outdated Show resolved Hide resolved
docs/implement-api-bindings.md Outdated Show resolved Hide resolved
docs/implement-api-bindings.md Outdated Show resolved Hide resolved
docs/http-rpc-clients.md Outdated Show resolved Hide resolved
docs/http-rpc-clients.md Outdated Show resolved Hide resolved
docs/http-rpc-clients.md Outdated Show resolved Hide resolved
@BigLep
Copy link
Contributor

BigLep commented Oct 17, 2022

@SgtPooki : I see I'm a requested reviewer. I don't know if I can get to it this week. Lets incorporate Lidel's feedback and then I think we'll call that good enough.

Co-authored-by: Marcin Rataj <lidel@lidel.org>
@SgtPooki SgtPooki requested review from BigLep and removed request for BigLep November 10, 2022 17:42
SgtPooki and others added 6 commits November 10, 2022 09:43
Co-authored-by: Marcin Rataj <lidel@lidel.org>
Co-authored-by: Marcin Rataj <lidel@lidel.org>
Co-authored-by: Marcin Rataj <lidel@lidel.org>
Co-authored-by: Marcin Rataj <lidel@lidel.org>
Co-authored-by: Marcin Rataj <lidel@lidel.org>
@SgtPooki SgtPooki requested a review from lidel November 10, 2022 17:45
@SgtPooki
Copy link
Member Author

@lidel ping

@SgtPooki SgtPooki dismissed lidel’s stale review November 21, 2022 05:26

addressed comments. need another review

docs/http-rpc-clients.md Outdated Show resolved Hide resolved
@lidel lidel merged commit a32128d into ipfs:master Nov 22, 2022
@SgtPooki SgtPooki deleted the docs/kubo-rpc-client branch November 23, 2022 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add mention of js-kubo-rpc-client to Kubo README
3 participants