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: mention kubo-rpc-client #1299

Merged
merged 4 commits into from
Nov 10, 2022
Merged

Conversation

SgtPooki
Copy link
Member

@SgtPooki SgtPooki commented Oct 5, 2022

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

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

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

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

@welcome
Copy link

welcome bot commented Oct 5, 2022

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned.
  • Your contribution itself is clear (grammar and spelling checked, any code blocks checked and commented) and in its best form. Follow the docs contribution guidelines if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on any missing things and potentially assigning a reviewer for high priority items.
  • The PR gets reviews, discussed and approvals as needed.
  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

@BigLep BigLep requested review from TMoMoreau and achingbrain and removed request for salmad3 October 5, 2022 22:36
@BigLep
Copy link
Contributor

BigLep commented Oct 5, 2022

We shouldn't block, but I added @achingbrain .

I also put the IPFS doc writer: @TMoMoreau .

Copy link
Contributor

@TMoMoreau TMoMoreau left a comment

Choose a reason for hiding this comment

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

This looks good to me.

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.

lgtm, if we address small issues described below

docs/reference/js/api.md Outdated Show resolved Hide resolved
docs/reference/js/api.md Outdated Show resolved Hide resolved
SgtPooki and others added 2 commits October 12, 2022 15:06
@SgtPooki
Copy link
Member Author

SgtPooki commented Oct 12, 2022

@TMoMoreau ready to merge after CI passes if you're good with the changes requested by lidel that I've addressed.

@BigLep
Copy link
Contributor

BigLep commented Oct 17, 2022

@TMoMoreau / @SgtPooki : lets get this merged :)

Copy link
Contributor

@salmad3 salmad3 left a comment

Choose a reason for hiding this comment

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

@TMoMoreau is out until mid next week. We can merge on his behalf. Just a small nit on how the APIs are referenced.

docs/reference/js/api.md Outdated Show resolved Hide resolved
docs/reference/js/api.md Outdated Show resolved Hide resolved
@salmad3
Copy link
Contributor

salmad3 commented Oct 19, 2022

@SgtPooki left a minor suggestion

@salmad3 salmad3 merged commit cdc1920 into ipfs:main Nov 10, 2022
@SgtPooki
Copy link
Member Author

Thanks for pushing this over the line @DannyS03, the last few weeks have been wild

@SgtPooki SgtPooki deleted the docs/mention-kubo-rpc-client branch November 10, 2022 17:37
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.

docs.ipfs.io - find mentions of and switch to where Kubo daemon is used
5 participants