From f573c1810a106ab6f8cda564cf5e7f8272082199 Mon Sep 17 00:00:00 2001
From: Dan Helfman <witten@torsion.org>
Date: Thu, 10 Oct 2019 14:27:48 -0700
Subject: [PATCH] Add a suggestion form to all documentation pages, so users
 can submit ideas for improving the documentation.

---
 NEWS                                          |  4 +++
 docs/_includes/components/suggestion-form.css | 18 ++++++++++
 .../_includes/components/suggestion-form.html | 33 +++++++++++++++++++
 docs/_includes/layouts/base.njk               |  1 +
 docs/_includes/layouts/main.njk               |  2 ++
 setup.py                                      |  2 +-
 6 files changed, 59 insertions(+), 1 deletion(-)
 create mode 100644 docs/_includes/components/suggestion-form.css
 create mode 100644 docs/_includes/components/suggestion-form.html

diff --git a/NEWS b/NEWS
index 2fdc12f52..029c107b3 100644
--- a/NEWS
+++ b/NEWS
@@ -1,3 +1,7 @@
+1.3.24.dev0
+ * Add a suggestion form to all documentation pages, so users can submit ideas for improving the
+   documentation.
+
 1.3.23
  * #174: More detailed error alerting via runtime context available in "on_error" hook.
 
diff --git a/docs/_includes/components/suggestion-form.css b/docs/_includes/components/suggestion-form.css
new file mode 100644
index 000000000..874faeaa2
--- /dev/null
+++ b/docs/_includes/components/suggestion-form.css
@@ -0,0 +1,18 @@
+#suggestion-form textarea {
+	font-family: sans-serif;
+	width: 100%;
+}
+
+#suggestion-form label {
+	font-weight: bold;
+}
+
+#suggestion-form input[type=email] {
+	font-size: 16px;
+	width: 100%;
+}
+
+#suggestion-form .form-error {
+        color: red;
+}
+
diff --git a/docs/_includes/components/suggestion-form.html b/docs/_includes/components/suggestion-form.html
new file mode 100644
index 000000000..c4e59b205
--- /dev/null
+++ b/docs/_includes/components/suggestion-form.html
@@ -0,0 +1,33 @@
+<h2>Improve this documentation</h2>
+
+<p>Have an idea on how to make this documentation even better? Send your
+feedback below! (But if you need help installing or using borgmatic, please
+use our <a href="https://torsion.org/borgmatic/#issues">issue tracker</a>
+instead.)</p>
+
+<form id="suggestion-form">
+    <div><label for="suggestion">Suggestion</label></div>
+    <textarea id="suggestion" rows="8" cols="60" name="suggestion"></textarea>
+    <div data-sk-error="suggestion" class="form-error"></div>
+    <input id="_page" type="hidden" name="_page">
+    <input id="_subject" type="hidden" name="_subject" value="borgmatic documentation suggestion">
+    <br />
+    <label for="email">Email address</label>
+    <div><input id="email" type="email" name="email" placeholder="Only required if you want a response!"></div>
+    <div data-sk-error="email" class="form-error"></div>
+    <br />
+    <div><button type="submit">Send</button></div>
+    <br />
+</form>
+
+<script>
+    document.getElementById('_page').value = window.location.href;
+    window.sk=window.sk||function(){(sk.q=sk.q||[]).push(arguments)};
+  
+    sk('form', 'init', {
+        id: '1d536680ab96',
+        element: '#suggestion-form'
+    });
+</script>
+
+<script defer src="https://js.statickit.com/statickit.js"></script>
diff --git a/docs/_includes/layouts/base.njk b/docs/_includes/layouts/base.njk
index 361967c5f..548f25198 100644
--- a/docs/_includes/layouts/base.njk
+++ b/docs/_includes/layouts/base.njk
@@ -11,6 +11,7 @@
 {% include 'components/minilink.css' %}
 {% include 'components/toc.css' %}
 {% include 'components/info-blocks.css' %}
+{% include 'components/suggestion-form.css' %}
 {% include 'prism-theme.css' %}
 {% include 'asciinema.css' %}
 {% endset %}
diff --git a/docs/_includes/layouts/main.njk b/docs/_includes/layouts/main.njk
index 25e7ac0f4..fc320ea33 100644
--- a/docs/_includes/layouts/main.njk
+++ b/docs/_includes/layouts/main.njk
@@ -8,5 +8,7 @@ headerClass: elv-header-default
 <main class="elv-layout{% if layoutClass %} {{ layoutClass }}{% endif %}">
     <article>
         {{ content | safe }}
+
+        {% include 'components/suggestion-form.html' %}
     </article>
 </main>
diff --git a/setup.py b/setup.py
index daceb552e..c93ba3ea6 100644
--- a/setup.py
+++ b/setup.py
@@ -1,6 +1,6 @@
 from setuptools import find_packages, setup
 
-VERSION = '1.3.23'
+VERSION = '1.3.24.dev0'
 
 
 setup(