ipfs-docs icon indicating copy to clipboard operation
ipfs-docs copied to clipboard

Edits to MacOS section of Kubo cmd line install instructions

Open ElPaisano opened this issue 3 years ago • 1 comments

Motivation: I was going through IPFS cmd line set up https://curriculum.pl-launchpad.io/curriculum/ipfs/setup/ for Launchpad, which depends on IPFS Docs’ installation instructions. I'm using a Mac with Apple Silicon. I noticed a couple things in the Mac install instructions. They're mostly tiny nitpicks and stylistic preferences but I think we should at least add the stuff about Apple vs Intel.

Proposed Changes:

  1. Adds step where the user determines whether they need the binary for an Intel or Apple-based system and removes tip box. This is to help clarify that the user must install the appropriate binary or they will run into issues - it appears that they can't just choose one or the other. I'm using a Mac with Apple silicon and I tried installing the binary for an Intel system just to see what would happen - it doesn't appear to work.
  2. Updates outdated command output in the "Unzip the file" step
  3. Nit: Breaks out steps into single actions i.e. separates the "change directory" step from the "run the install script" step
  4. Nit: Separates command output from the command run.
  5. Nits on phrasing and such

Note: If we make the changes suggested in 3 and 4 above, it would probably make sense to standardize the rest of the IPFS docs to match in future PR(s) i.e. all tutorials and processes have the same style.

ElPaisano avatar Sep 26 '22 22:09 ElPaisano

@TMoMoreau thank you for the review. I addressed most everything, with a few questions in the comment sections.

ElPaisano avatar Sep 27 '22 19:09 ElPaisano

@TMoMoreau resolved the merge conflict, can you do a sanity check visual read-through review on this one more time? I took a look as well. Should be good to go after that

https://bafybeihd3ljk6z53sbtj74kpxfxatr6rkybk73lzsmfaiqnc3awosk7pmm.on.fleek.co/install/command-line/#macos

ElPaisano avatar Nov 29 '22 19:11 ElPaisano

Let's squash and merge this one, since it's more than 1 commit

ElPaisano avatar Nov 30 '22 19:11 ElPaisano

Squashed and merged

ElPaisano avatar Nov 30 '22 19:11 ElPaisano