Updates on 01_Basics.md

[kvutien]

I'm a complete beginner in IPFS and OrbitDB. Very interesting tutorial. Thanks.

I took note as I went through it. Then I used the notes to do updates to the Markdown.

• I modified the text in the sense as I'd have wished to see them explained to me. I may have made interpretation mistakes. Feel free to correct.
• I made comments and suggestions to the authors of this tutorial.

The main suggestion I'd do here is to reduce to the minimum the cognitive load to a beginner. All the side remarks of the text are pertinent and important but many do not directly contribute to the main purpose, "to learn the basics".

For example, clearly distinguish the guide for the nodeJS user from the guide for the browser user. Else each user has to read also what is not interesting for him/her and this adds to the cognitive load.

I'm continuing this tutorial. Awesome.

[kvutien]

Sure Will make the changes and do another PR — VTK

Sent from my iPhone

On 24 Jun 2021, at 20:03, Mark Robert Henderson @.***> wrote:

 @aphelionz requested changes on this pull request.

This is great! Just some questions and changes.

In 01_Tutorial/01_Basics.md:

-Of course, be careful before copying and pasting any commands anyone ever tells you into your terminal. If you don't understand a command, figure out what it is supposed to do, before copying it over. Copy and paste at your own risk. +> Note: If you're running on a Windows prompt, or if you don't have certain build tools like g++ and python installed, you may see a noisy console output with lots of warnings and errors. Keep going, your code should still run. Let's keep both the windows note and the security advisory

In 01_Tutorial/01_Basics.md:

@@ -80,44 +99,44 @@ try {

 module.exports = exports = new NewPiecePlease(Ipfs, OrbitDB)

} catch (e) {

• window.NPP = new NewPiecePlease(window.Ipfs, window.OrbitDB)

• console.log(' -> caught an error:', err)
• var NPP = new NewPiecePlease(global.Ipfs, global.OrbitDB) // for nodeJS I bet we can actually use globalThis: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis

In 01_Tutorial/01_Basics.md:

-```JavaScript -NPP.onready = () => {

• console.log(NPP.orbitdb.id) -} +```js +$ node

• Welcome to Node.js v12.18.4.
• Type ".help" for more information. +> const NPP = require('./newpieceplease')
• undefined +> NPP.onready = () => {console.log(NPP.orbitdb.id)}
• [Function] +> NPP.create() +``` +> Note for the authors of this tutorial: When I ran for the first time this code from a newly created folder orbitdb-ch1, the output is different from the subsequent runs. At first run, the output is not what is described in the tutorial. It seems to come from the ipfs init command line and is like this Would you mind removing these from code and adding them as checklist items in the PR?

In 01_Tutorial/01_Basics.md:

+> Note for the authors of this tutorial: When I ran for the first time this code from a newly created folder orbitdb-ch1, the output is different from the subsequent runs. At first run, the output is not what is described in the tutorial. It seems to come from the ipfs init command line and is like this +> +> Promise { <pending> } +> > generating 2048-bit (rsa only) RSA keypair... +> to get started, enter: +> jsipfs cat /ipfs/QmfGBRT6BbWJd7yUc2uYdaUZJBbnEFvTqehPFoSMQ6wgdr/readme +> +>

+> If I exit node and run the sequence of commands again, the subsequent outputs are different and like what is described in the tutorial. +> +> Promise { <pending> } +> OrbitDB owner id: 03ecc23e7dfa8d1837ba979e719e934879c80dbd62fa0f42c84093f3ae53090e86 +> + +> I have no clue to explain, so I leave it to you. :D we'll add an explanation here

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or unsubscribe.

[aphelionz]

You can continue to push to this branch if you can, it would be cleaner than multiple PRs

[kvutien]

Done. Hope it's OK. Github is still a bit mysterious to me. :)

Vu Tien Khang

On 24 Jun 2021, at 20:20, Mark Robert Henderson @.***> wrote:

You can continue to push to this branch if you can, it would be cleaner than multiple PRs

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/orbitdb/field-manual/pull/144#issuecomment-867857077, or unsubscribe https://github.com/notifications/unsubscribe-auth/AHY2OUTSAXQHXTC76YKT6VTTUNZPZANCNFSM47H6OPNA.

[MinmoTech]

Sorry if this kind of comment is annoying, but could this be merged? :)

The last remaining issues could even be cleaned up afterwards, could they not? :grin:

[aphelionz]

Yes, somebody just needs to resolve the conflicts - @kvutien or @juligreen ?

[MinmoTech]

I'm not able to edit this PR though, right?

[kvutien]

Yes, somebody just needs to resolve the conflicts - @kvutien or @juligreen ?

I'd gladly do it, but I must humbly admit that my proficiency of Git is limited to fork, clone, status, add, commit, push, branch and merge. 🤷‍♂️ Resolving conflicts is something I can try, but I'm afraid I might mess up the Git. So I can volunteer if I'm the only one who is allowed by Github to do. Let me know.

[aphelionz]

You can do it @kvutien, we believe in you :D

you can git pull to make a merge commit or git rebase