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

Create a “best practices for busy builders” page. #491

Closed
lidel opened this issue Oct 6, 2020 · 5 comments · Fixed by #1079
Closed

Create a “best practices for busy builders” page. #491

lidel opened this issue Oct 6, 2020 · 5 comments · Fixed by #1079
Assignees
Labels
dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/enhancement A net-new feature or an improvement to an existing feature P3 Low: Not priority right now status/ready Ready to be worked topic/docs Documentation

Comments

@lidel
Copy link
Member

lidel commented Oct 6, 2020

We have some features which are disabled or are not defaults yet, but we encourage people to use them.
Having a single link with a list of such suggestions for busy builders could be handy

Topic ideas:

  • use cidv1 for future-proof addressing, and use in case-insensitive contexts
  • enable pubsub if you need fast IPNS
  • enable GC if your data churn is expected to be high
  • use subdomain gateways or DNSLink when publishing apps for secure context and origin isolation
@lidel lidel added need/triage Needs initial labeling and prioritization kind/suggestion Something that you'd like to see in the docs. This can be written content, web design, or imagery. labels Oct 6, 2020
@ipfs ipfs deleted a comment from welcome bot Oct 6, 2020
@johnnymatthews johnnymatthews added dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/enhancement A net-new feature or an improvement to an existing feature P3 Low: Not priority right now status/ready Ready to be worked topic/docs Documentation and removed kind/suggestion Something that you'd like to see in the docs. This can be written content, web design, or imagery. need/triage Needs initial labeling and prioritization labels Oct 7, 2020
@johnnymatthews johnnymatthews changed the title “best practices for busy builders” page Create a “best practices for busy builders” page. Oct 14, 2020
@Annamarie2019 Annamarie2019 moved this from Backlog to Todo in Protocol Docs Mar 1, 2022
@Annamarie2019 Annamarie2019 moved this from Todo to Backlog in Protocol Docs Mar 3, 2022
@Annamarie2019 Annamarie2019 moved this from Backlog to Todo in Protocol Docs Mar 9, 2022
@Annamarie2019 Annamarie2019 moved this from Todo to In Progress in Protocol Docs Mar 9, 2022
@Annamarie2019
Copy link
Contributor

@johnnymatthews I'll take this one. I think this is the last of the IPFS "good first issues," so I might as well finish them up, before I move on to others.

@Annamarie2019 Annamarie2019 self-assigned this Mar 10, 2022
@Annamarie2019 Annamarie2019 moved this from In Progress to In review in Protocol Docs Mar 14, 2022
@johnnymatthews johnnymatthews linked a pull request Mar 14, 2022 that will close this issue
@Annamarie2019
Copy link
Contributor

@lidel how does pubsub provide "fast IPNS"? Is it a kind of workaround?, so instead of enabling IPNS, just do a quick pub or sub on the fly? (Page almost done, PR: #1079)

@RuniteOre
Copy link
Contributor

@Annamarie2019 Pubsub can provide faster IPNS by pushing records over it. The first publish would still take a long time because you would need to advertise the topic into the DHT, but it will happen much faster.

@Annamarie2019 Annamarie2019 moved this from In review to In Progress in Protocol Docs Mar 15, 2022
@lidel
Copy link
Member Author

lidel commented Mar 16, 2022

Yep, "IPNS over Pubsub" can be enabled via CLI flag (legacy way) or config (current best practice):
https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md#ipns-pubsub

We don't have it enabled by default because we have no mechanism for unsubscribing from topics that were not used for a while. There is a tracking issue for remaining work: ipfs/kubo#8591

@Annamarie2019
Copy link
Contributor

@lidel One more question: For the ipfs config --json Ipns.UsePubsub true, you left the link to ipfs pubsub ipfs pubsub for its subcommands. I'm thinking that that's no longer relevant, or is it? Please confirm and I'll take it out.
(BTW, we're having a little trouble reconciling the changes in the PR, so I may need to create a new PR, but I've saved yours and Johnny's suggestions and the rest of the text.)

@Annamarie2019 Annamarie2019 moved this from In Progress to In review in Protocol Docs Mar 17, 2022
@Annamarie2019 Annamarie2019 moved this from In review to Done in Protocol Docs Mar 23, 2022
@johnnymatthews johnnymatthews moved this from Done to Archive of closed issues in Protocol Docs Apr 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/enhancement A net-new feature or an improvement to an existing feature P3 Low: Not priority right now status/ready Ready to be worked topic/docs Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants