Skip to content

Commit 6edfbf5

Browse files
authored
DOCS: Remove reference to ppush/ppreview, spelling fixes (#3940)
<!-- ## Before submiting a pull request Please make sure you've run the following commands from the root directory. bin/generate-all.sh (this runs commands like "go generate", fixes formatting, and so on) ## Release changelog section Help keep the release changelog clear by pre-naming the proper section in the GitHub pull request title. Some examples: * CICD: Add required GHA permissions for goreleaser * DOCS: Fixed providers with "contributor support" table * ROUTE53: Allow R53_ALIAS records to enable target health evaluation More examples/context can be found in the file .goreleaser.yml under the 'build' > 'changelog' key. !-->
1 parent 1fda952 commit 6edfbf5

File tree

6 files changed

+11
-12
lines changed

6 files changed

+11
-12
lines changed

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ When a major version is incremented, we'll support the previous major version fo
1212

1313
To report a vulnerability please [create a new GitHub "issue"](https://github.com/StackExchange/dnscontrol/issues/new/choose).
1414

15-
We will respond in a best-effort manner, usually within 1 week. We will communciate via the GitHub issue unless we need to communicate privately, in which case we'll arrange a way to communicate directly.
15+
We will respond in a best-effort manner, usually within 1 week. We will communicate via the GitHub issue unless we need to communicate privately, in which case we'll arrange a way to communicate directly.

commands/types/dnscontrol.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -975,7 +975,7 @@ declare const DISABLE_IGNORE_SAFETY_CHECK: DomainModifier;
975975
* * `ed25519`
976976
* * `notes` (string, optional): Human-readable notes intended for administrators. Pass normal text here; DKIM-Quoted-Printable encoding will be applied automatically. Maps to the `n=` tag.
977977
* * `servicetypes` (array, optional): Service types using this key. Maps to the `s=` tag. Supported values:
978-
* * `*`: explicity allows all service types
978+
* * `*`: explicitly allows all service types
979979
* * `email`: restricts key to email service only
980980
* * `flags` (array, optional): Flags to modify the interpretation of the selector. Maps to the `t=` tag. Supported values:
981981
* * `y`: Testing mode.
@@ -3572,7 +3572,7 @@ declare function SOA(name: string, ns: string, mbox: string, refresh: number, re
35723572
*
35733573
* ## Advanced Technique: Define once, use many
35743574
*
3575-
* In some situations we define an SPF setting once and want to re-use
3575+
* In some situations we define an SPF setting once and want to reuse
35763576
* it on many domains. Here's how to do this:
35773577
*
35783578
* ```javascript

documentation/advanced-features/json-reports.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ The report is JSON-formatted and contains the zonename, the provider or
66
registrar name, the number of changes (corrections), and the correction details.
77
All values are in text, values may contain `<`,`>` and `&` escape as needed.
88

9-
To generate the report, add the `--report <filename>` option to a preview or
10-
push command (this includes `preview`, `ppreview`, `push`,
11-
`ppush`).
9+
To generate the report, add the `--report <filename>` option to a `preview` or
10+
`push` command.
1211

1312
The report lists the changes that would be (preview) or are (push) attempted,
1413
whether they are successful or not.

documentation/advanced-features/nameservers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ D("example.com", REG_NONE,
9595
Suppose you don't want to manage a domain, but you want to list the zone in
9696
your `dnsconfig.js` file for inventory purposes. For example, suppose there are
9797
domains that some other part of your company maintains, but you want to list it
98-
in your `dnsconfig.js` because it is authoratative for the company.
98+
in your `dnsconfig.js` because it is authoritative for the company.
9999

100100
```javascript
101101
var REG_NONE = NewRegistrar("none");

documentation/advanced-features/ordering.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ D('example.com', REG_NONE, DnsProvider(DNS_BIND),
3535

3636
The re-ordering feature can be disabled using the `--disableordering` global flag (it goes before `preview` or `push`). While the code has been extensively tested, it is new and you may still find a bug. This flag leaves the updates unordered and may require multiple `push` runs to complete the update.
3737

38-
If you encounter any issues with the reordering please [open an issue](https://github.com/StackExchange/dnscontrol/issues).
38+
If you encounter any issues with the reordering please [open an issue](https://github.com/StackExchange/dnscontrol/issues).
3939

4040
## Internals
4141

42-
DNSControl sorts all changes based on the dependencies within these changes. Each record define it's dependencies in `models.Record`. For DNSControl it doesn't matter of a CNAME's target is an A or AAAA or TXT, it will ensure all changes on the target get sorted before the depending CNAME record. The creation of the graph happens in `dnsgraph.CreateGraph([]Graphable)` and thereafter the sorting happens in `graphsort.SortUsingGraph([]Graphable)`.
43-
The Graphable is an interface to make the sorting module more seperate from the rest of the DNSControl code, currently the only Graphable implementation is `diff2.Change`.
42+
DNSControl sorts all changes based on the dependencies within these changes. Each record define it's dependencies in `models.Record`. For DNSControl it doesn't matter of a CNAME's target is an A or AAAA or TXT, it will ensure all changes on the target get sorted before the depending CNAME record. The creation of the graph happens in `dnsgraph.CreateGraph([]Graphable)` and thereafter the sorting happens in `graphsort.SortUsingGraph([]Graphable)`.
43+
The Graphable is an interface to make the sorting module more separate from the rest of the DNSControl code, currently the only Graphable implementation is `diff2.Change`.
4444

45-
In order to add a new sortable rtype one should add it to the `models.Record.GetGetDependencies()` and return the dependent records, this is used inside the `diff2.Change` to detect if a depdency is backwards (dependent on the old state) or forward (dependent on new state). Now the new rtype should be sorted accordingly just like MX and CNAME records.
45+
In order to add a new sortable rtype one should add it to the `models.Record.GetGetDependencies()` and return the dependent records, this is used inside the `diff2.Change` to detect if a dependency is backwards (dependent on the old state) or forward (dependent on new state). Now the new rtype should be sorted accordingly just like MX and CNAME records.

documentation/language-reference/domain-modifiers/DKIM_BUILDER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ k2._domainkey.subdomain IN TXT "v=DKIM1; h=sha1:sha256; k=rsa; n=some=20human
9292
* `ed25519`
9393
* `notes` (string, optional): Human-readable notes intended for administrators. Pass normal text here; DKIM-Quoted-Printable encoding will be applied automatically. Maps to the `n=` tag.
9494
* `servicetypes` (array, optional): Service types using this key. Maps to the `s=` tag. Supported values:
95-
* `*`: explicity allows all service types
95+
* `*`: explicitly allows all service types
9696
* `email`: restricts key to email service only
9797
* `flags` (array, optional): Flags to modify the interpretation of the selector. Maps to the `t=` tag. Supported values:
9898
* `y`: Testing mode.

0 commit comments

Comments
 (0)