-
Notifications
You must be signed in to change notification settings - Fork 419
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
Adds new page with 4 best practices #1079
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @Annamarie2019!
Added some clarifications around IPNS over pubsub
…s-docs into builders-best-practices
@lidel and @johnnymatthews It looks like it's in there the way I intended now. (@lidel I removed the link that seemed to refer to the previous version of the code we had.) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, but I think the pubsub section is still confusing, see my comment below.
ps. I fixed some links
|
||
## Enable pubsub if you need fast IPNS | ||
|
||
Pubsub is one of the available options for configuring your IPFS node. It allows you to publish and subscribe to messages on a given topic. It can be a quick alternative to accessing data instead of setting up [IPNS](../concepts/ipns/#interplanetary-name-system-ipns). Pubsub is an experimental feature and it should not be used in a production environment. It is disabled by default. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This mixes two distinct concepts: "Pubsub" is a thing on its own, but here we talk about "IPNS over Pubsub" which will enable "Pubsub" and use it for faster IPNS record lookups.
In reality, people use this in production, so we should soften the warning and just ask people to be mindful when they opt-in.
Perhaps we could clarify this around these lines:
Pubsub is one of the available options for configuring your IPFS node. It allows you to publish and subscribe to messages on a given topic. It can be a quick alternative to accessing data instead of setting up [IPNS](../concepts/ipns/#interplanetary-name-system-ipns). Pubsub is an experimental feature and it should not be used in a production environment. It is disabled by default. | |
"[IPNS](../concepts/ipns/#interplanetary-name-system-ipns) over [Pubsub](../concepts/glossary/#pubsub)" is a way to accelerate publishing and resolution of IPNS records by asking both pubsub topic and DHT. It is an experimental feature and it should be used with care. It is disabled by default. |
@johnnymatthews @lidel Since the last time you reviewed this, I changed one piece: "## Enable pubsub for fast IPNS As a standalone feature, I see Marcin's suggestion is still here above if you need a comparison. I need you to have my back when I change what I think is better English, but maybe I got rid of some accepted engineer-speak. Thanks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
(I removed one sentence that was bit technically incorrect/confusing + we already had it phrased in a better way in sentence after the shell example)
|
Creates a new page with these 4 best practices (Issue #491):
@johnnymatthews : How do I get the new page into the directory? I'm thinking it should go into How-tos > Customize your install, right before Troubleshooting.