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

Update all tutorials to reflect async/await refactors to IPFS API #347

Closed
terichadbourne opened this issue Jan 16, 2020 · 2 comments · Fixed by #381
Closed

Update all tutorials to reflect async/await refactors to IPFS API #347

terichadbourne opened this issue Jan 16, 2020 · 2 comments · Fixed by #381

Comments

@terichadbourne
Copy link
Member

@alanshaw called out that the async/await changes being made to js-ipfs in ipfs/js-ipfs#2683 will make our lesson content outdated. (Nothing on the site will actually break until we update IPFS versions.) I'll schedule some time for us to chat about the scope of the changes and who's best equipped to make updates.

@alanshaw
Copy link
Member

alanshaw commented Feb 4, 2020

js-ipfs 0.41.0-rc.0 is out now if this was a blocker at all....

@zebateira
Copy link
Contributor

Thank you @alanshaw 🙏

I poked around your migration guide, and from what I could tell, there are two breaking changes that we need to deal with: ipfs.add and ipfs.cat

So basically, almost the entire Regular Files API tutorial.

@alanshaw @terichadbourne would appreciate your opinion on this: in .add and .cat we now need to pipe/concat all the data of a file.
To update the tutorials code exercises, I'm thinking of two options:

  1. We could simply mention why we need to do this and then simply add the it-concat and it-pipe modules to make the code solutions easier.
  2. Another option would be to already include the for await ... loops in the code solution with its code block empty ready for the users to fill in the solution code.

What do you think?

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 a pull request may close this issue.

3 participants