Skip to content
This repository was archived by the owner on Jun 2, 2020. It is now read-only.

Commit 63f3f53

Browse files
committed
Fix grammar, heading level, and links for DNSLink
License: MIT Signed-off-by: Rob Brackett <[email protected]>
1 parent 50e0039 commit 63f3f53

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

content/guides/concepts/dnslink.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@ menu:
55
parent: concepts
66
---
77

8-
DNSLink uses DNS TXT records to map a domain name (like `ipfs.io`) to an IPFS
9-
address. Because you can edit your DNS records, you can use them to always
10-
point to the latest version of an object in IPFS (remember that an IPFS
11-
object’s address changes if you modify the object). Because DNSLink uses DNS
12-
records, the names it produces are also usually easy to type and read.
8+
DNSLink uses [DNS TXT](https://en.wikipedia.org/wiki/TXT_record) records to map
9+
a domain name (like `ipfs.io`) to an IPFS address. Because you can edit your
10+
DNS records, you can use them to always point to the latest version of an
11+
object in IPFS (remember that an IPFS object’s address changes if you modify
12+
the object). Because DNSLink uses DNS records, the names it produces are also
13+
usually easy to type and read.
1314

1415
A DNSLink address looks like an [IPNS](/guides/concepts/ipns) address, but it
1516
uses a domain name in place of a hashed public key:
@@ -24,16 +25,15 @@ Just like normal IPFS addresses, they can include links to other files:
2425
/ipns/ipfs.io/media/
2526
```
2627

27-
2828
When an IPFS client or node attempts to resolve that address, it looks for a `TXT` record for `ipfs.io` with content like:
2929

3030
```
3131
dnslink=/ipfs/<CID for your content here>
3232
```
3333

34-
For example, if you look up `ipfs.io`’s DNS records, you’ll see its DNSLink entry.
34+
For example, if you look up `ipfs.io`’s DNS records, you’ll see its DNSLink entry:
3535

36-
```
36+
```sh
3737
$ dig +noall +answer TXT ipfs.io
3838
ipfs.io. 59 IN TXT "dnslink=/ipfs/QmYNQJoKGNHTpPxCBPh9KkDpaExgd2duMa3aF6ytMpHdao"
3939
```
@@ -50,27 +50,23 @@ Will get you this block:
5050
/ipfs/QmYNQJoKGNHTpPxCBPh9KkDpaExgd2duMa3aF6ytMpHdao/media/
5151
```
5252

53-
### Publish via Subdomain
5453

55-
It is possible to publish DNSLink using a special subdomain named `_dnslink`.
54+
## Publishing via a Subdomain
5655

57-
This is useful when you want to improve security of automated setup or
58-
delegate control over DNSLink to a third-party without giving full control over
59-
the original DNS zone.
56+
You can also publish DNSLink records using a special subdomain named `_dnslink`. This is useful when you want to improve the security of an automated setup or delegate control over your DNSLink records to a third-party without giving away full control over the original DNS zone.
6057

61-
Example: `docs.ipfs.io` may not not have a TXT record, but the page still loads
62-
because TXT record exists for `_dnslink.docs.ipfs.io`:
58+
For example, [`docs.ipfs.io`](https://docs.ipfs.io) does not have a TXT record, but the page still loads
59+
because a TXT record exists for `_dnslink.docs.ipfs.io`:
6360

64-
```
61+
```sh
6562
$ dig +noall +answer TXT _dnslink.docs.ipfs.io
6663
_dnslink.docs.ipfs.io. 34 IN TXT "dnslink=/ipfs/QmeveuwF5wWBSgUXLG6p1oxF3GKkgjEnhA6AAwHUoVsx6E"
6764
```
6865

69-
<!-- Not sure if IPNS is fast enough to mention here
66+
<!-- TODO: Once IPNS is more reliable, describe combining it with DNSLink.
7067
### Linking to IPNS
7168
7269
DNSLink can point at [IPNS](/guides/concepts/ipns) paths as well. IPNS path is
7370
a mutable pointer which enables you to update your website by publishing
7471
to a PeerID without the need for updating TXT record every time hash changes.
7572
-->
76-

0 commit comments

Comments
 (0)