diff --git a/NEWS b/NEWS index 2fdc12f..029c107 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 0000000..874faea --- /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 0000000..c4e59b2 --- /dev/null +++ b/docs/_includes/components/suggestion-form.html @@ -0,0 +1,33 @@ +

Improve this documentation

+ +

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 issue tracker +instead.)

+ +
+
+ +
+ + +
+ +
+
+
+
+
+
+ + + + diff --git a/docs/_includes/layouts/base.njk b/docs/_includes/layouts/base.njk index 361967c..548f251 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 25e7ac0..fc320ea 100644 --- a/docs/_includes/layouts/main.njk +++ b/docs/_includes/layouts/main.njk @@ -8,5 +8,7 @@ headerClass: elv-header-default
{{ content | safe }} + + {% include 'components/suggestion-form.html' %}
diff --git a/setup.py b/setup.py index daceb55..c93ba3e 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(