Skip to content

Improve Examples section #29

Closed
Closed
Improve Examples section#29
Assignees
salmad3
Labels
area:guidesTutorials, how-tos, examples, and common guides.needs thinking

Description

@yusefnapora
yusefnapora
opened on Mar 19, 2019

The current examples section just links to external sources for go, js and rust.

I think there's a big opportunity to take those external examples and rework them a bit, pull them into the site, and use them as teaching tools to walk people through libp2p use cases.

I think that keeping the examples in their own repos will probably work best, since that's the easiest place to keep them up-to-date and integrated with CI.

My tentative plan is to clone the example repos as part of the build process for this site, run them through some formatting, and embed the result into the site.

For this to work well, some work needs to be done on the example repos so that they all have enough narrative & framing around them, and I need to develop the formatting / build process.

Activity

  1. yusefnapora
    added
    enhancement
    on Mar 19, 2019
  2. yusefnapora
    self-assigned this
    on Mar 19, 2019

  3. tristanisham commented on Mar 19, 2022

    @tristanisham
    tristanisham
    on Mar 19, 2022

    @yusefnapora I created a pull for the Go getting started example. In its current state, it won't compile. There's no mention of the necessary declaration of ctx as seen in the last two code snippets of the document.

     // The context governs the lifetime of the libp2p node.
// Cancelling it will stop the the host.
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

  4. p-shahi commented on Aug 26, 2022

    @p-shahi
    p-shahi
    on Aug 26, 2022
    Member

    Reach out to other implementations (Python, Nim, Zig, etc) to be included in examples page. Will close the child tickets in favor of this one. @DannyS03 plans to combine the Tutorials and Examples section in the future, so some of this work will be addressed by that.

  5. p-shahi
    added
    P2Medium
    on Aug 26, 2022
  6. salmad3
    assigned
    salmad3
    and unassigned
    yusefnapora
    on Aug 29, 2022
  7. p-shahi
    added this to go-libp2pon Aug 29, 2022
  8. salmad3
    moved this to 🏃‍♀️ In Progress in go-libp2pon Aug 31, 2022
  9. salmad3
    added
    area:guidesTutorials, how-tos, examples, and common guides.
    type:enhancementContent enhancement, new feature or request.
    type:new pageNew content page
    needs thinking
    and removed
    enhancement
    type:enhancementContent enhancement, new feature or request.
    type:new pageNew content page
    on Nov 23, 2022
  10. salmad3
    removed
    P2Medium
    on Jan 9, 2023

  11. salmad3 commented on Jan 9, 2023

    @salmad3
    salmad3
    on Jan 9, 2023
    Contributor

    After having touched on this issue (and idea) a few times in the latter half of 2022, the preference among the stewards is to keep the examples in their respective repos.

    We also have a general "Guides" section now that provides guides to get started with libp2p, and it will continue to refer to the examples in each repo (for example, as mentioned here). Implementations that do not have a getting started guide will be added shortly.

    As a result, let's close this and revisit if necessary.

  12. salmad3
    closed this as completedon Jan 9, 2023
  13. github-project-automation
    moved this from 🏃‍♀️ In Progress to 🎉 Done in go-libp2pon Jan 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

area:guidesTutorials, how-tos, examples, and common guides.needs thinking

Type

No type

Projects

  • go-libp2p
    Status
    🎉 Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions