Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for the "plan a" change #1499

Merged
merged 40 commits into from
May 8, 2022
Merged

Update docs for the "plan a" change #1499

merged 40 commits into from
May 8, 2022

Conversation

tlimoncelli
Copy link
Contributor

@tlimoncelli tlimoncelli commented May 4, 2022

Update the provider docs to match the code changes in #1457

Also edit the providers docs to be consistent:

  1. Always begin the "configuration" subsection with "To use this provider, add an entry to creds.json with TYPE set to ..."
  2. Change "Javascript" to "the dnsconfig.js" file.
  3. Change registrars to REG_ and DNS service providers to DSP_
  4. Use double-quotes in javascript into of single-quotes
  5. Use new-style (single parameter) NewDnsProvider/NewRegistrar.
  6. Clarify unclear statements
  7. Change "Use this provider like any other DNS Provider" to "An example dnsconfig.js configuration" in many, many, files.

tlimoncelli and others added 30 commits April 21, 2022 16:14
An RRSet (=label) consisting of multiple records with different TTLs is
something not supported by most providers, and should be avoided.
Furthermore it is deprecated in rfc2181#section-5.2

Emit a warning for now during validation, eventually turning it into a full-blown error.

Fixes #1372
Code would previously emit a warning for each record it found matching a
previously found label but with a different ttl. This could potentially become
too verbose of an output for larger zones.

Split the loop into two loops, one storing labels and their records' TTLs, the
second checking for multiple TTLs, in order to minimize the messages logged to
one message per problematic label, regardless for the number of records involved.
An RRSet (=label) consisting of multiple records with different TTLs is
something not supported by most providers, and should be avoided.
Furthermore it is deprecated in rfc2181#section-5.2

Emit a warning for now during validation, eventually turning it into a full-blown error.

Fixes #1372
@tlimoncelli tlimoncelli merged commit 533eabe into master May 8, 2022
@tlimoncelli tlimoncelli deleted the tlim_planadocs branch May 8, 2022 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants