Skip to content
This repository has been archived by the owner on Jul 5, 2021. It is now read-only.

deal with two frequently asked questions #253

Closed
wants to merge 5 commits into from

Conversation

Stebalien
Copy link
Contributor

  1. Warn that users installing IPFS in a shared environment should pass --profile=server on init.
  2. Clarify that the HASH in /ipfs/HASH/readme should not be replaced with the peer ID.

@Stebalien
Copy link
Contributor Author

Where are my auto-builds, previews and robot minions? Lies! Damn lies!

@ghost
Copy link

ghost commented Feb 6, 2018

Push an updated commit, I merged #250 :)


<div class="alert alert-info">
Note the hash there may differ. If it does, use the one you got.
Note, `HASH` in the `ipfs cat /ipfs/HASH/readme` command may differ. If it does, use the one you got. Do *not* use your peer ID.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do not use your peer ID.

This sounds really ominous, like you'll break something if you use your peer ID. I think you just want to say something like "Don't confuse this with the peer identity hash -- the peer identity hash is something your IPFS node uses to identify itself to other nodes. You want the content hash from the line that looks like ipfs cat /ipfs/QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/readme

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Speaking of which, we need a HAL easter egg.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed. Thoughts? I'm trying to keep the peer ID explanation as a separate note.

@flyingzumwalt
Copy link
Contributor

@Stebalien the markdown is not rendering from the lines that you modified. I'm not sure why.

@flyingzumwalt
Copy link
Contributor

Also, FYI, this section in the DWeb primer goes through these steps more clearly https://dweb-primer.ipfs.io/install-ipfs/lessons/initialize-repository.html

doesn't render per markdown spec :(
@Stebalien Stebalien force-pushed the stebalien/doc-fixes branch 3 times, most recently from 91b89fe to 04b1ca2 Compare February 7, 2018 02:10
@Stebalien
Copy link
Contributor Author

I've also fixed the info/warning styling.

@flyingzumwalt that site doesn't load for me.

Mr0grog added a commit to ipfs-inactive/docs that referenced this pull request Jun 1, 2018
Originally from ipfs-inactive/website#253

License: MIT
Signed-off-by: Rob Brackett <rob@robbrackett.com>
@Mr0grog
Copy link
Contributor

Mr0grog commented Jun 2, 2018

I’ve added all the content from this (slightly reworded since I’d already written some of it before realizing you’d already done this, @Stebalien) to the new docs site PR at ipfs-inactive/docs#68. Since that’s hopefully going to replace this, should we keep this around or no?

@Stebalien
Copy link
Contributor Author

If we're deprecating this documentation, it's probably not worth it to keep it around. Closing.

@Stebalien Stebalien closed this Jun 2, 2018
@ghost ghost removed the in progress label Jun 2, 2018
@ghost ghost deleted the stebalien/doc-fixes branch August 16, 2018 17:31
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants