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

[DOCS] Add note about IPNS and DNSLink #6696

Closed
wants to merge 1 commit into from
Closed

Conversation

parkan
Copy link

@parkan parkan commented Oct 2, 2019

Using a DNS alias to point to a gateway is not well documented outside the dnslink.io site, this adds a reference to those docs to the main go-ipfs documentation.

Using a DNS alias to point to a gateway is not well documented outside the dnslink.io site, this adds a reference to those docs to the main go-ipfs documentation.
@parkan parkan changed the title Add note about IPNS and DNSLink [DOCS] Add note about IPNS and DNSLink Oct 2, 2019
Copy link
Member

@Stebalien Stebalien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks but this feels a bit out of place.

@@ -43,6 +43,18 @@ your query string to explicitly specify the filename. For example:

> https://ipfs.io/ipfs/QmfM2r8seH2GiRaC4esTjeraXEachRt8ZsSeGaWTPLyMoG?filename=hello_world.txt

## IPNS & DNSLink
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't seem like the right place for this documentation. This document is about gateway features and these are just general IPFS features.

Maybe we should add sentence to the top saying that the gateway provides access to files/directories served on IPFS and then briefly describe /ipns/... and /ipfs/...?

@parkan
Copy link
Author

parkan commented Oct 3, 2019

that's fair, the main thing that I want to point out is the fact that the gateway can accept the ipns/dnslink name via Host header instead of url parameter (or subdomain), which doesn't seem well documented other than on the dnslink site

happy to reword this with more focus on that or move elsewhere

@Stebalien
Copy link
Member

that's fair, the main thing that I want to point out is the fact that the gateway can accept the ipns/dnslink name via Host header instead of url parameter (or subdomain), which doesn't seem well documented other than on the dnslink site

Ah, that makes a lot of sense.

@Stebalien
Copy link
Member

#6767

@Stebalien Stebalien closed this Nov 16, 2019
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

Successfully merging this pull request may close these issues.

2 participants