Skip to content
This repository has been archived by the owner on Jun 2, 2020. It is now read-only.

Creating basic examples on how to use go-ipfs Programatically (with the Core API) #300

Closed
daviddias opened this issue Oct 1, 2019 · 10 comments · Fixed by #363
Closed

Creating basic examples on how to use go-ipfs Programatically (with the Core API) #300

daviddias opened this issue Oct 1, 2019 · 10 comments · Fixed by #363
Assignees
@daviddias @johnnymatthews
Labels
dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week topic/design-content Content design, writing, information architecture topic/docs Documentation

Comments

@daviddias
Copy link

Examples such as https://docs.ipfs.io/guides/examples/api/service/readme are out of date and the Documentation of the go core API has a big TODO -- https://github.com/ipfs/interface-go-ipfs-core#documentation --. This means that, AFAICouldFind, there are no set of basic examples on how to spawn your own go-ipfs node from a Go Program.

It would be extremely helpful to have at least 1 to 2 examples that show users how they can use go-ipfs from their go programs. For inspiration:
@daviddias daviddias transferred this issue from ipfs/kubo Oct 1, 2019
@jessicaschilling
Copy link
Contributor

jessicaschilling commented Oct 1, 2019 •
edited
Loading

@daviddias Great point. The existing team doesn’t have the bandwidth to swarm on this right now, unfortunately; do you have an inclination to knock out a rough draft (I’m more than happy to copy edit), or do you have recommendations for someone who can take this work in? Thank you!

@daviddias
Copy link
Author

daviddias commented Oct 1, 2019 •
edited
Loading

Understood. I was looking for an example I could use myself. It is currently unclear to me how much of the CoreAPI for go-ipfs -- https://github.com/ipfs/interface-go-ipfs-core -- is ready/done/released. Once I get something to work cleanly, I'm happy to allocate a couple of hours getting a 101 example written.

While I figure that out, one thing to consider doing right now is hiding examples that are broken in the docs page.

@jessicaschilling
Copy link
Contributor

Yay, thanks! I found those legacy examples last week while working on something else, but based on accuracy of the legacy examples already on docs.ipfs wanted to take a closer look before releasing back into the wild. If you’ve found ones you want to release right away lmk — it’s reasonably quick for me to do that legwork.

@jessicaschilling jessicaschilling added topic/design-content Content design, writing, information architecture dif/medium Prior experience is likely helpful docs-ipfs topic/docs Documentation effort/days Estimated to take multiple days, but less than a week labels Oct 7, 2019
@daviddias
Copy link
Author

Update: I started working on this example. Code being written here ipfs/kubo#6695

@jessicaschilling
Copy link
Contributor

Awesome, please keep us posted 😊

@daviddias
Copy link
Author

Hiiii docs team! Got something for you ipfs/kubo#6695

It's complete and ready for review. Would love to get this shipped soon and potentially also ship a blog post to let our users know that they can use IPFS in this way as well.

@jessicaschilling
Copy link
Contributor

From @daviddias re where to put this guide in the legacy nav: note that we're addressing the js-ipfs examples in the new beta nav. But will hide the "make your own service" link per screenshot.
image.png

jessicaschilling added a commit that referenced this issue Oct 23, 2019
@jessicaschilling
Removed "Making Your Own IPFS Service" from left nav
9a50933 
ref #300 (comment)
@jessicaschilling jessicaschilling mentioned this issue Oct 23, 2019
Merged
@daviddias
Copy link
Author

It has beeeen meeeerged \o/ https://github.com/ipfs/go-ipfs/tree/master/docs/examples/go-ipfs-as-a-library :D

@daviddias
Copy link
Author

Got you a blog post as well ipfs-inactive/blog#322 :D

jessicaschilling added a commit that referenced this issue Oct 29, 2019
@jessicaschilling
Adds sidebar nav link to go-ipfs library tutorial
a44379d 
closes #300
@jessicaschilling jessicaschilling mentioned this issue Oct 29, 2019
Merged
@jessicaschilling
Copy link
Contributor

Link added in legacy docs site! Queued up in the beta as well. Thank you!

@jessicaschilling jessicaschilling mentioned this issue Dec 16, 2019
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@daviddias daviddias

@johnnymatthews johnnymatthews

Labels
dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week topic/design-content Content design, writing, information architecture topic/docs Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Adds sidebar nav link to go-ipfs library tutorial ipfs-inactive/docs
3 participants
@daviddias @jessicaschilling @johnnymatthews