From 6edfbf507854b2792c40bf008c0d86cb71a381c7 Mon Sep 17 00:00:00 2001 From: Andrew Imeson Date: Mon, 22 Dec 2025 23:52:34 -0500 Subject: [PATCH] DOCS: Remove reference to ppush/ppreview, spelling fixes (#3940) --- SECURITY.md | 2 +- commands/types/dnscontrol.d.ts | 4 ++-- documentation/advanced-features/json-reports.md | 5 ++--- documentation/advanced-features/nameservers.md | 2 +- documentation/advanced-features/ordering.md | 8 ++++---- .../language-reference/domain-modifiers/DKIM_BUILDER.md | 2 +- 6 files changed, 11 insertions(+), 12 deletions(-) diff --git a/SECURITY.md b/SECURITY.md index 3012daec9..89ba4cb48 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -12,4 +12,4 @@ When a major version is incremented, we'll support the previous major version fo To report a vulnerability please [create a new GitHub "issue"](https://github.com/StackExchange/dnscontrol/issues/new/choose). -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. +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. diff --git a/commands/types/dnscontrol.d.ts b/commands/types/dnscontrol.d.ts index 382fcaeba..ddeb29af4 100644 --- a/commands/types/dnscontrol.d.ts +++ b/commands/types/dnscontrol.d.ts @@ -975,7 +975,7 @@ declare const DISABLE_IGNORE_SAFETY_CHECK: DomainModifier; * * `ed25519` * * `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. * * `servicetypes` (array, optional): Service types using this key. Maps to the `s=` tag. Supported values: - * * `*`: explicity allows all service types + * * `*`: explicitly allows all service types * * `email`: restricts key to email service only * * `flags` (array, optional): Flags to modify the interpretation of the selector. Maps to the `t=` tag. Supported values: * * `y`: Testing mode. @@ -3572,7 +3572,7 @@ declare function SOA(name: string, ns: string, mbox: string, refresh: number, re * * ## Advanced Technique: Define once, use many * - * In some situations we define an SPF setting once and want to re-use + * In some situations we define an SPF setting once and want to reuse * it on many domains. Here's how to do this: * * ```javascript diff --git a/documentation/advanced-features/json-reports.md b/documentation/advanced-features/json-reports.md index 7a0424174..25b87a873 100644 --- a/documentation/advanced-features/json-reports.md +++ b/documentation/advanced-features/json-reports.md @@ -6,9 +6,8 @@ The report is JSON-formatted and contains the zonename, the provider or registrar name, the number of changes (corrections), and the correction details. All values are in text, values may contain `<`,`>` and `&` escape as needed. -To generate the report, add the `--report ` option to a preview or -push command (this includes `preview`, `ppreview`, `push`, -`ppush`). +To generate the report, add the `--report ` option to a `preview` or +`push` command. The report lists the changes that would be (preview) or are (push) attempted, whether they are successful or not. diff --git a/documentation/advanced-features/nameservers.md b/documentation/advanced-features/nameservers.md index b71fa64af..ebca13250 100644 --- a/documentation/advanced-features/nameservers.md +++ b/documentation/advanced-features/nameservers.md @@ -95,7 +95,7 @@ D("example.com", REG_NONE, Suppose you don't want to manage a domain, but you want to list the zone in your `dnsconfig.js` file for inventory purposes. For example, suppose there are domains that some other part of your company maintains, but you want to list it -in your `dnsconfig.js` because it is authoratative for the company. +in your `dnsconfig.js` because it is authoritative for the company. ```javascript var REG_NONE = NewRegistrar("none"); diff --git a/documentation/advanced-features/ordering.md b/documentation/advanced-features/ordering.md index ff2bae6ed..6448e7c7d 100644 --- a/documentation/advanced-features/ordering.md +++ b/documentation/advanced-features/ordering.md @@ -35,11 +35,11 @@ D('example.com', REG_NONE, DnsProvider(DNS_BIND), 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. -If you encounter any issues with the reordering please [open an issue](https://github.com/StackExchange/dnscontrol/issues). +If you encounter any issues with the reordering please [open an issue](https://github.com/StackExchange/dnscontrol/issues). ## Internals -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)`. -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`. +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)`. +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`. -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. +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. diff --git a/documentation/language-reference/domain-modifiers/DKIM_BUILDER.md b/documentation/language-reference/domain-modifiers/DKIM_BUILDER.md index f0e3cd340..2ccb14c3e 100644 --- a/documentation/language-reference/domain-modifiers/DKIM_BUILDER.md +++ b/documentation/language-reference/domain-modifiers/DKIM_BUILDER.md @@ -92,7 +92,7 @@ k2._domainkey.subdomain IN TXT "v=DKIM1; h=sha1:sha256; k=rsa; n=some=20human * `ed25519` * `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. * `servicetypes` (array, optional): Service types using this key. Maps to the `s=` tag. Supported values: - * `*`: explicity allows all service types + * `*`: explicitly allows all service types * `email`: restricts key to email service only * `flags` (array, optional): Flags to modify the interpretation of the selector. Maps to the `t=` tag. Supported values: * `y`: Testing mode.