Expand IPNS concept doc

[Mr0grog]

This issue has a bounty!

Successfully closing this issue by producing a production-ready piece of documentation can earn you not only the undying love of the IPFS community — it can net you a financial reward. See the current list of bounty issues and their values here.

The need in brief

We need to expand and improve upon the existing IPNS page in our docs; information is incomplete and some is out of date.

At the IPFS developer summit in Berlin in July 2018, we had poster-making sessions where people explored various IPFS concepts. Please examine the posters (contacts for their creators can be provided if necessary) and include its information both in the body text of the revised doc, and in a graphic suitable for publishing on the IPFS docs beta site.

Additionally, please examine the more recent material that has been developed on related topics:

• IPNS specs
• IPFS camp deep dives on fast ipns, link rot, and rotating keys
• The definitive guide to publishing content on the decentralized web
• What is InterPlanetary Naming System(IPNS)?

Please both link out to these artifacts in a "further information" section at the end of the doc, as well as incorporate summary/high-level concepts from the artifacts within the doc itself.

Finally, please examine the existing content in the original doc and update any content that may be inconsistent, unclear, or out of date.

Deliverable

An expansion of the original concept doc that fully integrates the considerations outlined above. As a whole, this revised concept doc should answer the following, supplemented whenever possible by diagrams, videos and/or code examples:

• What is this?
• How does it relate to the rest of IPFS?
• What are some generic use cases for this — how might it meet a need in someone's project/goal?
• How can (or should?) you use it? (Note: sometimes the answer is that you should understand it, but not necessarily use it based on your use case or the current state of the tech.)
• Where do you go to learn more?
• What is the current state of this concept or technology?

Content should take the form of a Markdown document, supplemented by diagrams as embedded images. File locations should be as follows:

• MD content should live here (please make a PR against the existing document) https://github.com/ipfs/ipfs-docs-v2/blob/master/docs/concepts/ipns.md
• Images can live in the MD content's parent directory; we'll move them before final merge
• For videos, just post temporarily on the platform of your choice, and we'll sort out on a case-by-case basis

Guidelines

• Please use the IPFS Docs Contributor Guidelines as your north star — adherence to these guidelines are crucial when it comes to awarding potential bounty!
• Also, please keep in mind our core user personae. If a piece of content serves one or more personae in particular, make sure it checks out with that persona's attributes.

[jessicaschilling]

@johnnymatthews What say you to putting a bounty on this one?

[jessicaschilling]

Bounty added! This one is up for grabs. Please comment if you'd like to take it on! The reward is USD $500.

[dzhelezov]

Is this issue still open for grabs?

[jessicaschilling]

Sure is! Just assigned it to you. @johnnymatthews is running the docs show these days, so please check in with him for any questions!

[johnnymatthews]

Hey @dzhelezov! The issue is still open, but with the release of Go-IPFS 0.5 coming out next week, there's a bunch of changes to this doc just about to go out. So for now, there aren't any major changes necessary for this doc. There's still loads you can help out with though! Check back next week for a fresh set of bounties.

[dzhelezov]

Hi @johnnymatthews! awesome news, thanks for the update! As far as I understood IPNS is going to support ENS, handshake and pretty much any other protocol in a plugin fashion, is it already available in 0.5? Would be happy to cover that as well once available.

[bertrandfalguiere]

@dzhelezov, are you still working on it? I would like to take this on if you don't plan to work on it anymore.

[dzhelezov]

@dzhelezov, are you still working on it? I would like to take this on if you don't plan to work on it anymore.

Hi sure feel free to take it, but I am not sure about the current status of this issue -- @johnnymatthews put it on hold back in April

[johnnymatthews]

Oh wow, I dropped the ball on this one. Sorry about that. Yes this project is back up for grabs! I'll assign it to you @dzhelezov if you're ready? There's some features in Go-IPFS 0.6 that might affect this page. Feel free to email me (address on my GitHub profile with any questions).

[dzhelezov]

@johnnymatthews I am currently busy with another project so perhaps @bertrandfalguiere can take over. I would be happy to share what I've researched and compiled back in April.

[johnnymatthews]

Sorry, through the wrong username in my last comment. @bertrandfalguiere if you're available it's all yours.

[bertrandfalguiere]

@johnnymatthews To be exact, I'll be on vacation Friday and the next week. I will be able to work on it after that, so if someone is available before july 13th, they can have the ticket, otherwise I'll handle it myself.
@dzhelezov Having your previous work would help, thanks for offering it.

[dzhelezov]

Here's a (small) write-up I added to the IPNS page: master...dzhelezov:master

[dzhelezov]

The following additional resources may be useful to follow the development of IPNS, but I guess some additional care should be taken to figure out what has been actually implemented in IPFS 0.5:

• IPNS with multiple resolvers specs#198
• Allow resolution of .eth names via .eth.link kubo#6448
• docs(ADDRESSING): default DNSLink to ipfs:// in-web-browsers#150
• Feature request: add link type /dns/<domain name> notes#348
• How does Resolution and Routing work with IPFS? ipfs-inactive/faq#48

[realChainLife]

@bertrandfalguiere are you still working on this? I can give it a go if you're not

[bertrandfalguiere]

Yes, still on it. I will ship end of next week, though.

[johnnymatthews]

How's this issue going @bertrandfalguiere?

[BlocksOnAChain]

we can close since we have: https://docs.ipfs.io/concepts/ipns/#example-ipns-setup-with-cli