From 5ba66fac52ebdcd587a4c0e257ff63e7a28057e2 Mon Sep 17 00:00:00 2001
From: Jeffrey Cafferata <jeffrey@jcid.nl>
Date: Sun, 30 Oct 2022 18:45:04 +0100
Subject: [PATCH] DOCS: Add missing record modifiers (#1793)

---
 .../record/CAA_BUILDER.md}                       | 11 +++++++----
 docs/_functions/record/DMARC_BUILDER.md          | 16 ++++++++++++++--
 .../record/SPF_BUILDER.md}                       | 14 ++++++++++----
 docs/code-tricks.md                              |  7 ++++---
 docs/index.md                                    |  4 ++--
 docs/toc.md                                      |  2 +-
 6 files changed, 38 insertions(+), 16 deletions(-)
 rename docs/{caa-builder.md => _functions/record/CAA_BUILDER.md} (93%)
 rename docs/{spf-optimizer.md => _functions/record/SPF_BUILDER.md} (98%)

diff --git a/docs/caa-builder.md b/docs/_functions/record/CAA_BUILDER.md
similarity index 93%
rename from docs/caa-builder.md
rename to docs/_functions/record/CAA_BUILDER.md
index 0e89fa4ec..119548e1e 100644
--- a/docs/caa-builder.md
+++ b/docs/_functions/record/CAA_BUILDER.md
@@ -1,10 +1,13 @@
 ---
-layout: default
-title: CAA Builder
+name: CAA_BUILDER
+parameters:
+  - label
+  - iodef
+  - iodef_critical
+  - issue
+  - issuewild
 ---
 
-# CAA Builder
-
 dnscontrol contains a CAA_BUILDER which can be used to simply create
 CAA records for your domains. Instead of creating each CAA record
 individually, you can simply configure your report mail address, the
diff --git a/docs/_functions/record/DMARC_BUILDER.md b/docs/_functions/record/DMARC_BUILDER.md
index 70b7a1af3..72bec48e9 100644
--- a/docs/_functions/record/DMARC_BUILDER.md
+++ b/docs/_functions/record/DMARC_BUILDER.md
@@ -1,9 +1,21 @@
 ---
 name: DMARC_BUILDER
+parameters:
+  - label
+  - version
+  - policy
+  - subdomainPolicy
+  - alignmentSPF
+  - alignmentDKIM
+  - percent
+  - rua
+  - ruf
+  - failureOptions
+  - failureFormat
+  - reportInterval
+  - ttl
 ---
 
-# DMARC Builder
-
 dnscontrol contains a DMARC_BUILDER which can be used to simply create
 DMARC policies for your domains.
 
diff --git a/docs/spf-optimizer.md b/docs/_functions/record/SPF_BUILDER.md
similarity index 98%
rename from docs/spf-optimizer.md
rename to docs/_functions/record/SPF_BUILDER.md
index 623a2df57..0c76bef54 100644
--- a/docs/spf-optimizer.md
+++ b/docs/_functions/record/SPF_BUILDER.md
@@ -1,10 +1,16 @@
 ---
-layout: default
-title: SPF Optimizer
+name: SPF_BUILDER
+parameters:
+  - label
+  - overflow
+  - overhead1
+  - raw
+  - ttl
+  - txtMaxSize
+  - parts
+  - flatten
 ---
 
-# SPF Optimizer
-
 dnscontrol can optimize the SPF settings on a domain by flattening
 (inlining) includes and removing duplicates.  dnscontrol also makes
 it easier to document your SPF configuration.
diff --git a/docs/code-tricks.md b/docs/code-tricks.md
index 3b9be722e..baff7d7e4 100644
--- a/docs/code-tricks.md
+++ b/docs/code-tricks.md
@@ -9,8 +9,9 @@ Problem: It is difficult to get CAA and other records exactly right.
 
 Solution: Use a "builder" to construct it for you.
 
-* [CAA Builder]({{site.github.url}}/caa-builder)
-* [SPF Optimizer]({{site.github.url}}/spf-optimizer)
+* [CAA Builder]({{site.github.url}}/js#CAA_BUILDER)
+* [DMARC Builder]({{site.github.url}}/js#DMARC_BUILDER)
+* [SPF Optimizer]({{site.github.url}}/js#SPF_BUILDER)
 
 # Repeat records in many domains (macros)
 
@@ -139,5 +140,5 @@ domain exists, who requested it, any associated ticket numbers, and so
 on.
 
 We also comment the individual parts of a record. Look at the [SPF
-Optimizer]({{site.github.url}}/spf-optimizer) example.  Each part of
+Optimizer]({{site.github.url}}/js#SPF_BUILDER) example.  Each part of
 the SPF record has a comment.
diff --git a/docs/index.md b/docs/index.md
index 404d1f90c..bf00812fc 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -147,10 +147,10 @@ title: DNSControl
                     <a href="{{site.github.url}}/alias">Aliases</a>: ALIAS/ANAME records
                 </li>
                 <li>
-                    <a href="{{site.github.url}}/spf-optimizer">SPF Optimizer</a>: Optimize your SPF records
+                    <a href="{{site.github.url}}/js#SPF_BUILDER">SPF Optimizer</a>: Optimize your SPF records
                 </li>
                 <li>
-                    <a href="{{site.github.url}}/caa-builder">CAA Builder</a>: Build CAA records the easy way
+                    <a href="{{site.github.url}}/js#CAA_BUILDER">CAA Builder</a>: Build CAA records the easy way
                 </li>
             </ul>
         </div>
diff --git a/docs/toc.md b/docs/toc.md
index 11e29e3f7..5c6b70b3e 100644
--- a/docs/toc.md
+++ b/docs/toc.md
@@ -17,7 +17,7 @@ title: TOC
 
 ## Advanced Topics
 - [Testing]({{site.github.url}}/unittests): Unit Testing DNS Data.
-- [SPF Optimizer]({{site.github.url}}/spf-optimizer): Optimize your SPF records.
+- [SPF Optimizer]({{site.github.url}}/js#SPF_BUILDER): Optimize your SPF records.
 
 ## Developer info
 - [GitHub](https://github.com/StackExchange/dnscontrol): Get the source!