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

Add/extended (Sub) Section for IPNS #162

Closed
8 tasks done
mrodriguez3313 opened this issue Jul 5, 2022 · 1 comment
Closed
8 tasks done

Add/extended (Sub) Section for IPNS #162

mrodriguez3313 opened this issue Jul 5, 2022 · 1 comment
Assignees
Labels
content-request A request for additional content to be created for curriculum IPFS belongs in the IPFS section of the curriculum L Work size Large (3 days-week)

Comments

@mrodriguez3313
Copy link
Contributor

mrodriguez3313 commented Jul 5, 2022

(Sub) Section for IPNS

Purpose

To add more content about IPNS into the curriculum. This can either be its own section or add on to the current subsection that currently exists in "Mutable Content"

Proposed Solution

  • Graphics and a couple paragraphs about how IPNS works in more detail
    • Graphics - fix "pinning options" image to portray a clearer & more relevant message
    • paragraphs
  • Short explanation of tradeoffs and common shortfalls
  • Show/describe how publish/subcribe (pubsub) works along with it and compliments it
  • Show/describe how IPNS works with DNS (aka DNSLink) and use ipfs.io as an example
  • Add content about the IPNS records themselves (nonce value, expiration time, IPNS object, etc...).
  • Short videos for how to operate IPNS from CLI

It would be cool to show what you can do with IPNS. We have already shown how to publish something with IPNS in "The IPFS API (Tutorial)". But we can show how to enable pubsub with IPNS, we can show how to publish with a generated key that is not "self" (your default key on your ipfs node), export and import keys. All of this is best operated through the CLI, in my experience, so we can also do a short video going through this process and it will be easy to follow. These videos can be similar to ones done in "IPFS Setup (Tutorial)" It can extend and compliment the content in docs.ipfs.io/ipns. It would be a big rabbit hole if we go too much into the weeds of IPNS because of a variety of edge cases that have no easy solutions/explanations. So the trick will be to hint at those issues without addressing them too explicitly. This can farm engagement for deep dives.

Where Can we find out more about this topic?
Here are some resources that explain common points regarding IPNS:

Milestones

1) Publish written learning material (2 weeks; 1 for write ups + 1 week for possible time-delayed technical reviews)
This includes material for IPNS, Pubsub+IPNS, and DNSLink. Both Deep and Shallow tracks.

2) Video guides (2 week, 1 week for research and recording + 1 week for editing and time-delayed reviews)
This includes CLI follow-alongs and, if feasible, programmable guides

3) Merge into main from gitbook
Due to curriculum website change, the final step is moving the merged content from gitbook -> mutable-content.md into main -> mutable-content.md

Acceptance Criteria

Acceptable resolution of this issue would entail written teaching material for IPNS, DNSlink, & routing options and tradeoffs.

@mrodriguez3313 mrodriguez3313 added IPFS belongs in the IPFS section of the curriculum content-request A request for additional content to be created for curriculum L Work size Large (3 days-week) labels Jul 5, 2022
@mrodriguez3313 mrodriguez3313 changed the title Major Curriculum Change or Addition - Topic Add/extended (Sub) Section for IPNS Jul 5, 2022
@mrodriguez3313
Copy link
Contributor Author

Completed this issue with this final commit d112a2428f695e915c0969524d8c0ccd6cd366da

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content-request A request for additional content to be created for curriculum IPFS belongs in the IPFS section of the curriculum L Work size Large (3 days-week)
Projects
Status: Done
Development

No branches or pull requests

1 participant