DOCS: Fix typos, word usage, and inline code in docs (#1805)

This commit is contained in:
Andrew Imeson 2022-11-03 09:12:08 -04:00 committed by GitHub
parent 975463ef33
commit 7fd35e85f8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 13 additions and 13 deletions

View file

@ -55,7 +55,7 @@ anything at a particular label, therefore DNSControl prevents you from
adding records at a label that is `IGNORE_NAME`'ed.
Use `IGNORE_NAME("@")` to ignore at the domain's apex. Most providers
insert magic or unchangable records at the domain's apex; usually `NS`
insert magic or unchangeable records at the domain's apex; usually `NS`
and `SOA` records. DNSControl treats them specially.
# Errors

View file

@ -8,7 +8,7 @@ parameters:
PTR adds a PTR record to the domain.
The name is normally a the relative label for the domain, or a FQDN that ends with `.`. If magic mode is enabled (see below) it can also be an IP address, which will be replaced by the proper string automatically, thus
The name is normally a relative label for the domain, or a FQDN that ends with `.`. If magic mode is enabled (see below) it can also be an IP address, which will be replaced by the proper string automatically, thus
saving the user from having to reverse the IP address manually.
Target should be a string representing the FQDN of a host. Like all FQDNs in DNSControl, it must end with a `.`.

View file

@ -9,7 +9,7 @@ example `REV('1.2.3.0/24')` returns `3.2.1.in-addr.arpa.` and
`REV('2001:db8:302::/48)` returns `2.0.3.0.8.b.d.0.1.0.0.2.ip6.arpa.`.
This is used in `D()` functions to create reverse DNS lookup zones.
This is a convenience function. You could specify `D('3.2.1.in-addr.arpa`,
This is a convenience function. You could specify `D('3.2.1.in-addr.arpa',
...` if you like to do things manually but why would you risk making
typos?
@ -26,7 +26,7 @@ If the address does not include a "/" then `REV` assumes /32 for IPv4 addresses
and /128 for IPv6 addresses.
Note that the lower bits (the ones outside the netmask) must be zeros. They are not
zeroed out automatically. Thus, `REV('1.2.3.4/24') is an error. This is done
zeroed out automatically. Thus, `REV('1.2.3.4/24')` is an error. This is done
to catch typos.
{% capture example %}

View file

@ -64,8 +64,8 @@ D("example.tld", REG, DSP, ...
"~all"
],
flatten: [
"spf-basic.fogcreek.com", // Rational: Being deprecated. Low risk if it breaks.
"450622.spf05.hubspotemail.net" // Rational: Unlikely to change without warning.
"spf-basic.fogcreek.com", // Rationale: Being deprecated. Low risk if it breaks.
"450622.spf05.hubspotemail.net" // Rationale: Unlikely to change without warning.
]
}),
);

View file

@ -27,7 +27,7 @@ Example:
"TYPE": "CSCGLOBAL",
"api-key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"user-token": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
"notification_emails": "test@exmaple.tld,hostmaster@example.tld"
"notification_emails": "test@example.tld,hostmaster@example.tld"
}
}
```

View file

@ -124,7 +124,7 @@ without too much hand-holding. Complexity prevents that.
Isolate the clever stuff from what a typical user will need to edit.
At Stack Overflow, we put all our macro defintions and fancy stuff at
At Stack Overflow, we put all our macro definitions and fancy stuff at
the top of the file. The domains are later in the file.
We name the macros to be easy to understand for the user. For

View file

@ -142,7 +142,7 @@ Please adopt the NEW format when your installation has eliminated any use of DNS
Message: `ERROR: Mismatch found! creds.json entry ... has ... set to ... but dnsconfig.js specifies New*(..., ...)`
This indicates that the provider type specifed in `creds.json` does not match the one specifed in `dnsconfig.js` or on the command line.
This indicates that the provider type specified in `creds.json` does not match the one specified in `dnsconfig.js` or on the command line.
The fix is to change one to match the other.

View file

@ -9,7 +9,7 @@ The website is a static website generated by [Jekyll](https://jekyllrb.com/docs/
The website is generated from the files in `$GIT/dnscontrol/docs`. If a file
has a `.md` extension, it will be turned into an HTML file. Otherwise it is
copied verbatium.
copied verbatim.
# Directory Hierarchy

View file

@ -28,7 +28,7 @@ this may be useful if:
At Stack Overflow we have dual-hosted DNS i.e. zones having
nameservers at two different DNS providers. Most Let's Encrypt systems
do not support DNS validation in that case. DNSControl's `get-certs`
command leverages the core DNSControl commands when issueing
command leverages the core DNSControl commands when issuing
certificates, therefore dual-hosted DNS is supported.
## General Process

View file

@ -41,7 +41,7 @@ Release notes style guide:
* Entries in the bullet list should be phrased in the positive: "Feature FOO now does BAR". This is often the opposite of the related issue, which was probably phrased, "Feature FOO is broken because of BAR".
* Every item should include the ID of the issue related to the change. If there was no issue, create one and close it.
* Sort the list most important/exciting changes earlier in the list.
* Items related to a specific provier should begin with the all-caps name of the provider, such as "ROUTE53: Added support for sandwiches (#100)"
* Items related to a specific provider should begin with the all-caps name of the provider, such as "ROUTE53: Added support for sandwiches (#100)"
* The `Deprecation warnings` section should just copy from `README.md`. If you change one, change it in the README too (you can make that change in this PR).
See [https://github.com/StackExchange/dnscontrol/releases for examples](https://github.com/StackExchange/dnscontrol/releases) for recent release notes and copy that style.

View file

@ -37,7 +37,7 @@ var REG_GANDI = NewRegistrar("gandi");
var DSP_CF = NewDnsProvider("cloudflare_tal");
```
The second paramter (`GANDI_V5` and `CLOUDFLAREAPI` in the
The second parameter (`GANDI_V5` and `CLOUDFLAREAPI` in the
above examples) has moved to `creds.json` instead. It will be in a `TYPE`
field, which all providers have. It can appear in both places for backwards compatibility for now.