From c69bd436785956cb1f49e9078e07b05d40136cfd Mon Sep 17 00:00:00 2001 From: tomf Date: Thu, 24 Aug 2023 14:31:04 +0000 Subject: [PATCH] Doc fixes noticed while writing a provider (#2530) Co-authored-by: Tom Limoncelli --- documentation/testing-txt-records.md | 2 +- documentation/writing-providers.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/testing-txt-records.md b/documentation/testing-txt-records.md index 5c79b3d9e..695426e9b 100644 --- a/documentation/testing-txt-records.md +++ b/documentation/testing-txt-records.md @@ -1,6 +1,6 @@ # TXT record testing -We recently discovered a strange but with processing TXT records and +We recently discovered a strange bug with processing TXT records and double-quotes. Sadly we haven't been able to determine a way to test this automatically. Therefore, I've written up this methodology. diff --git a/documentation/writing-providers.md b/documentation/writing-providers.md index 4580cbddc..b83e83f96 100644 --- a/documentation/writing-providers.md +++ b/documentation/writing-providers.md @@ -223,6 +223,7 @@ an automated way to test for this bug. The manual steps are here in * Edit [README.md](https://github.com/StackExchange/dnscontrol): Add the provider to the bullet list. * Edit [documentation/providers.md](https://github.com/StackExchange/dnscontrol/blob/master/documentation/providers.md): Add the provider to the provider list. +* Edit [documentation/SUMMARY.md](https://github.com/StackExchange/dnscontrol/blob/master/documentation/SUMMARY.md): Add the provider to the provider list. * Create `documentation/providers/PROVIDERNAME.md`: Use one of the other files in that directory as a base. * Edit [OWNERS](https://github.com/StackExchange/dnscontrol/blob/master/OWNERS): Add the directory name and your GitHub username.