From 594007e61b9e7a4f535bcd62332f06e8c5caa73e Mon Sep 17 00:00:00 2001 From: mknell-godaddy Date: Mon, 16 Nov 2026 15:46:56 -0500 Subject: [PATCH 1/2] docs(dns): fix style findings in the DNS guide Why: the guide style rules report 26 findings in dns.md. A later change makes the check blocking, so each guide has to pass first. This is the second guide, split out so the DNS reviewers see only their own text. What changed: wording only, each edit keeping its meaning. Em dashes became periods, commas or a colon-free summary. Headings use the imperative form ("Manage DNS", "List records", "Add records", "Replace records", "Delete records"), including two the rule's gerund list doesn't match, so the guide reads the same throughout. "does not", "is not" and "are not" became contractions, "e.g." became "for example", and slashes that stood for "and" now say "and". Three passive phrases are active, and three sentences over 30 words are split. The summary line now has no colon, so it stays valid YAML. The "see ... below" pointer in the CNAME paragraph names the `set` section instead of "below". No Rust files change. No test reads this guide's text, and nothing links to the renamed headings. --- rust/src/dns/guides/dns.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/rust/src/dns/guides/dns.md b/rust/src/dns/guides/dns.md index fbfa8ee6..0aa54963 100644 --- a/rust/src/dns/guides/dns.md +++ b/rust/src/dns/guides/dns.md @@ -1,21 +1,21 @@ --- -summary: Manage DNS records with gddy — list, add, set, and delete +summary: Manage DNS records with gddy by listing, adding, setting, and deleting them --- -# Managing DNS with `gddy` +# Manage DNS with `gddy` `gddy dns` manages a domain's DNS records with the following commands: | Command | Destructive? | Purpose | |---|---|---| -| `dns list` | No | List records, optionally filtered by type/name | +| `dns list` | No | List records, optionally filtered by type and name | | `dns add` | No | Append new records | | `dns set` | Yes | Replace every record for a type+name | | `dns delete` | Yes | Remove every record for a type+name | -`NS` and `SOA` records are managed by GoDaddy and read-only — you can list them, but not add, set, or delete them. +`NS` and `SOA` records are managed by GoDaddy and read-only. You can list them, but not add, set, or delete them. -## Listing records +## List records ``` gddy dns list example.com @@ -25,7 +25,7 @@ gddy dns list example.com --type A --name www Without filters, `list` returns every record. `--type` narrows to one record type; `--name` further narrows to one name and requires `--type`. -## Adding records +## Add records `add` appends new records without touching anything that already exists: @@ -33,13 +33,13 @@ Without filters, `list` returns every record. `--type` narrows to one record typ gddy dns add example.com --type A --name www --data 192.0.2.1 --ttl 3600 ``` -Pass `--data` more than once to add several records for the same type+name in one call — each becomes a separate record, and a failure on one doesn't stop the rest (the result reports created/failed counts with a per-value breakdown). `--ttl` defaults to 3600 seconds when omitted. +Pass `--data` more than once to add several records for the same type+name in one call. Each becomes a separate record, and a failure on one doesn't stop the rest. The result reports counts of created and failed records, with a per-value breakdown. `--ttl` defaults to 3600 seconds when omitted. -A name can hold a CNAME or other record types, never both. Adding into a name that already has the other kind fails with an error naming the conflict — see `set --replace-conflicting-types` below if you actually want to replace it. +A name can hold a CNAME or other record types, never both. Adding into a name that already has the other kind fails with an error naming the conflict. To replace it instead, use `set --replace-conflicting-types`, covered in the `set` section. -## Replacing records (`set`, destructive) +## Replace records (`set`, destructive) -`set` replaces every record matching a type+name pair with exactly the `--data` value(s) you give it. It reconciles rather than deleting and recreating everything: existing records are paired with your `--data` values, whatever's no longer in your list is deleted, and whatever's new is created. There's no atomic in-place replace in v3, so each paired value is written as a new record before the old one it's replacing is deleted — record IDs are not reused across a replace. +`set` replaces every record matching a type+name pair with exactly the `--data` value(s) you give it. It reconciles rather than deleting and recreating everything. It pairs existing records with your `--data` values, deletes whatever's no longer in your list, and creates whatever's new. There's no atomic in-place replace in v3, so `set` writes each paired value as a new record before it deletes the old one it replaces. Record IDs aren't reused across a replace. ``` gddy dns set example.com --type TXT --name @ --data "v=spf1 -all" @@ -51,11 +51,11 @@ Preview the plan before writing: gddy dns set example.com --type TXT --name @ --data "v=spf1 -all" --dry-run ``` -The dry-run preview lists the planned action (replace/create/delete) per record so you can confirm it before it runs for real. `set` is not atomic — a partial failure reports how many records were replaced, created, and deleted before it happened. +The dry-run preview lists the planned action (replace, create, or delete) per record so you can confirm it before it runs for real. `set` isn't atomic. A partial failure reports how many records were replaced, created, and deleted before it happened. To also remove a conflicting CNAME (or, when setting a CNAME, any other type) at that name, add `--replace-conflicting-types`. -## Deleting records +## Delete records `delete` removes every record matching a type+name pair: @@ -65,7 +65,7 @@ gddy dns delete example.com --type A --name www Deleting something that doesn't match is a no-op success (`deleted: 0`), not an error. Preview with `--dry-run` first for anything you're not fully sure about. -For `SRV` and `TLSA` records, the name does not include the service or port: `--type SRV --name chat` matches every SRV record listed under `chat`, whatever its service, so `list` or `--dry-run` first to see which will be removed. To target one service, give the full name instead, e.g. `--name _sip._tcp.chat` (for `TLSA`, `_443._tcp.www`). +For `SRV` and `TLSA` records, the name doesn't include the service or port. `--type SRV --name chat` matches every SRV record listed under `chat`, whatever its service, so run `list` or `--dry-run` first to see which will be removed. To target one service, give the full name instead, for example `--name _sip._tcp.chat` (for `TLSA`, `_443._tcp.www`). ## International domain names @@ -73,10 +73,10 @@ Domain names and record names can be typed either as Unicode (`münchen.de`) or ## Type-specific flags -Most of these only apply to certain record types — set them only when the type calls for it: +Most of these only apply to certain record types, so set them only when the type calls for it: | Flag | Applies to | Notes | |---|---|---| | `--priority` | `MX`, `SRV` | | | `--port`, `--weight`, `--protocol`, `--service` | `SRV` | | -| `--flag`, `--tag` | `CAA` | `--tag` is required for CAA (e.g. `issue`, `issuewild`, `iodef`); `--data` carries the CA domain/value | +| `--flag`, `--tag` | `CAA` | CAA records require `--tag` (for example `issue`, `issuewild`, `iodef`), and `--data` carries the CA domain, which is the record value | From bbf484fb2cbeda8c94b1a224d631305a344035c9 Mon Sep 17 00:00:00 2001 From: mknell-godaddy Date: Mon, 16 Nov 2026 16:33:34 -0500 Subject: [PATCH 2/2] docs(dns): describe the CAA --data value by tag, not as a CA domain Why: the guide lists issue, issuewild and iodef as CAA tags. For issue and issuewild the value is a CA domain, but for iodef it is a reporting URL such as a mailto: address. My earlier rewrite of "the CA domain/value" said the value is the CA domain, which is wrong for iodef and could lead a reader to enter an invalid value. A review comment caught it. Decision: say --data carries the value for the selected tag, with a CA domain as the example. That keeps the original's looseness without the false claim. --- rust/src/dns/guides/dns.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rust/src/dns/guides/dns.md b/rust/src/dns/guides/dns.md index 0aa54963..9789ee16 100644 --- a/rust/src/dns/guides/dns.md +++ b/rust/src/dns/guides/dns.md @@ -79,4 +79,4 @@ Most of these only apply to certain record types, so set them only when the type |---|---|---| | `--priority` | `MX`, `SRV` | | | `--port`, `--weight`, `--protocol`, `--service` | `SRV` | | -| `--flag`, `--tag` | `CAA` | CAA records require `--tag` (for example `issue`, `issuewild`, `iodef`), and `--data` carries the CA domain, which is the record value | +| `--flag`, `--tag` | `CAA` | CAA records require `--tag` (for example `issue`, `issuewild`, `iodef`), and `--data` carries the value for that tag, for example a CA domain |