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

List external ressources / tutorials on rust-libp2p #5717

Open
elenaf9 opened this issue Dec 5, 2024 · 2 comments
Open

List external ressources / tutorials on rust-libp2p #5717

elenaf9 opened this issue Dec 5, 2024 · 2 comments

Comments

@elenaf9
Copy link
Contributor

elenaf9 commented Dec 5, 2024

In the last community call, the topic of external resources on (rust-)libp2p came up.

There are quite a few useful ones out there, e.g.:

I wanted to open the discussion on whether we want do include links to such resources in our repo, e.g. in as a ## External Resources section in our examples/README.md.
I think they can help newcomers quite a bit.

However, because they are external, there is also the risk of them being or becoming outdated and not working with our current API anymore.

@seetadev
Copy link

Thank you for bringing up the topic of external resources for rust-libp2p. I completely agree that well-curated external resources can be incredibly valuable for newcomers and even experienced developers looking to deepen their understanding of peer-to-peer networking with Rust. Resources like tutorials and live coding sessions often provide practical insights and step-by-step guidance that can complement our official documentation and examples. Wish to suggest some more external resources, which we may include:

  1. Tutorials

  2. Video Guides

  3. Blog Posts

  4. Advanced/Specialized Topics

@seetadev
Copy link

As discussed in yesterday's libp2p Community Call and recent maintainer's call, I'd like to share some feedback and thoughts on including external resources to scale developer adoption:

Pros of Including External Resources:
Accelerated Learning: Community tutorials offer hands-on experiences that can significantly shorten the learning curve for new contributors.
Broader Perspectives: External resources explore diverse use cases, design choices, and problem-solving approaches beyond our core documentation.
Community Engagement: Showcasing community-created content promotes involvement and highlights real-world applications.

Managing the Risk of Outdated Content:
To address concerns about resource compatibility, wish to propose:
Regular Review Process: Conduct periodic reviews (quarterly/semi-annually) to check resource compatibility with the current rust-libp2p API.
Clear Disclaimer: Add a prominent note explaining that external resources may not reflect the latest API changes.
Community Feedback Loop: Create a dedicated channel for reporting outdated links and suggesting new resources.

Recommended Curation Strategy:

  • Implement quarterly resource reviews
  • Include clear disclaimers about potential API changes
  • Foster community contributions and feedback
  • Maintain rigorous technical accuracy checks

Adding an External Resources section to examples/README.md can enhance the onboarding experience and provide valuable learning paths for developers. By implementing periodic reviews, clear disclaimers, and community-driven curation, we can mitigate the risk of outdated content while maximizing the value of these resources.

Thoughts and further input are welcome :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants