docs: Add trim_whitespaces plugin to relnotes and documentation

Rather than mentioning a hypothetical module restrictfive, we use the
existing plugin mediagoblin-licenses that people can install. Also,
mention that plugin in the release notes.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>

diff --git a/docs/source/siteadmin/plugins.rst b/docs/source/siteadmin/plugins.rst
index 75562d4b2f9b0b4fbb33f5ad7514a114fd51ded0..baca381dd8f449acf15b0d049e2d419bf635c5d2 100644 (file)
--- a/docs/source/siteadmin/plugins.rst
+++ b/docs/source/siteadmin/plugins.rst
@@ -44,29 +44,33 @@ If the plugin is available on the `Python Package Index
     pip install <plugin-name>
 
 For example, if we wanted to install the plugin named
-"mediagoblin-restrictfive", we would do::
+"mediagoblin-licenses" (which allows you to customize the licenses you
+offer for your media), we would do::
 
-    pip install mediagoblin-restrictfive
+    pip install mediagoblin-licenses
 
 .. Note::
 
    If you're using a virtual environment, make sure to activate the
-   virtual environment before installing with pip. Otherwise the
-   plugin may get installed in a different environment than the one
-   MediaGoblin is installed in.
+   virtual environment before installing with pip. Otherwise the plugin
+   may get installed in a different environment than the one MediaGoblin
+   is installed in. Also make sure, you use e.g. pip-2.7 if your default
+   python (and thus pip) is python 3 (e.g. in Ubuntu).
 
 Once you've installed the plugin software, you need to tell
 MediaGoblin that this is a plugin you want MediaGoblin to use. To do
 that, you edit the ``mediagoblin.ini`` file and add the plugin as a
 subsection of the plugin section.
 
-For example, say the "mediagoblin-restrictfive" plugin had the Python
-package path ``restrictfive``, then you would add ``restrictfive`` to
+For example, say the "mediagoblin-licenses" plugin has the Python
+package path ``mediagoblin_licenses``, then you would add ``mediagoblin_licenses`` to
 the ``plugins`` section as a subsection::
 
     [plugins]
 
-    [[restrictfive]]
+    [[mediagoblin_licenses]]
+    license_01=abbrev1, name1, http://url1
+    license_02=abbrev2, name1, http://url2
 
 
 Configuring plugins
@@ -112,7 +116,7 @@ Removing plugins
 
 To remove a plugin, use ``pip uninstall``. For example::
 
-    pip uninstall mediagoblin-restrictfive
+    pip uninstall mediagoblin-licenses
 
 .. Note::
 

diff --git a/docs/source/siteadmin/relnotes.rst b/docs/source/siteadmin/relnotes.rst
index 1b70b31c87dc28cc629e651a09e3861e4e989322..56267eb1cab7c040edd55200db41e57556d54de6 100644 (file)
--- a/docs/source/siteadmin/relnotes.rst
+++ b/docs/source/siteadmin/relnotes.rst
@@ -49,6 +49,12 @@ carefully, or at least skim over it.
 
   See :ref:`core-plugin-section` for plugin documentation
 
+* **trim_whitespace**
+
+  We bundle the optional plugin trim_whitespace which reduces the size
+  of the delivered html output by reducing redundant whitespace.
+
+  See :ref:`core-plugin-section` for plugin documentation
 
 0.3.0
 =====