Fix some docs build warnings.

diff --git a/docs/source/api/activities.rst b/docs/source/api/activities.rst
index cbbd1fab1af5eb29d441b1f334a7d8da44c5a0dd..b3828c34641cdd504fb95c337941006ac368b9c6 100644 (file)
--- a/docs/source/api/activities.rst
+++ b/docs/source/api/activities.rst
@@ -83,7 +83,7 @@ to represent "albums" or collections of media however they can represent anythin
 be used in the future to represent lists/groups of users which you can send activities to.
 
 Example
-^^^^^^^
+-------
 A collection which contains two images::
 
     {

diff --git a/docs/source/api/authentication.rst b/docs/source/api/authentication.rst
index 2db4a7bdaadd9a012396d6814500b2cb9ec2e32f..860783e30dc629ae110ca93b45d554ec11d99b7f 100644 (file)
--- a/docs/source/api/authentication.rst
+++ b/docs/source/api/authentication.rst
@@ -53,7 +53,7 @@ redirect_uri
 
 
 Response
-^^^^^^^^
+--------
 
 You will get back a response:
 
@@ -67,10 +67,10 @@ expires_at
     This is time that the client credentials expire. If this is 0 the client registration does not expire.
 
 Examples
---------
+~~~~~~~~
 
 Register Client
-^^^^^^^^^^^^^^^
+---------------
 
 To register a client for the first time, this is the minimum you must supply::
 
@@ -89,7 +89,7 @@ A Response will look like::
 
 
 Updating Client
-^^^^^^^^^^^^^^^
+---------------
 
 Using the response we got above we can update the information and add new information we may have opted not to supply::
 
@@ -113,7 +113,7 @@ The response will just return back the client_id and client_secret you sent::
 
 
 Possible Registration Errors
-----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 There are a number of errors you could get back, This explains what could cause some of them:
 

diff --git a/docs/source/api/objects.rst b/docs/source/api/objects.rst
index 854febe1aacc7fa032ad8df5190cae6a9ae8bd49..dcb6809022c49f364cb5d3db8aecc39e948accc6 100644 (file)
--- a/docs/source/api/objects.rst
+++ b/docs/source/api/objects.rst
@@ -11,7 +11,7 @@
    Dedication along with this software. If not, see
    <http://creativecommons.org/publicdomain/zero/1.0/>.
 
-.. info:: Currently only image uploading is supported.
+.. note:: Currently only image uploading is supported.
 
 =======
 Objects

diff --git a/docs/source/siteadmin/deploying.rst b/docs/source/siteadmin/deploying.rst
index 9488d94b0c3076bbf070bedd3069572cb378a71b..d20f017089cb833c205ede36855ac52ea83fbb1d 100644 (file)
--- a/docs/source/siteadmin/deploying.rst
+++ b/docs/source/siteadmin/deploying.rst
@@ -17,7 +17,7 @@
 Deploying MediaGoblin
 =====================
 
-Following this deployment guide will take you step-by-step through
+This deployment guide will take you step-by-step through
 setting up your own instance of MediaGoblin.
 
 MediaGoblin most likely isn't yet available from your operating
@@ -104,7 +104,7 @@ server and RabbitMQ to store the media processing queue::
      sudo dnf config-manager --set-enabled PowerTools
      sudo dnf install rabbitmq-server
      sudo systemctl enable rabbitmq-server.service
-     # TODO: Celery repeatedly disconnects from RabbitMQ.
+     # TODO: Celery repeatedly disconnects from RabbitMQ on CentOS 8.
 
    As an alternative, you can try installing redis-server and
    configure it as celery broker.
@@ -119,18 +119,19 @@ Configure PostgreSQL
    deployments. For medium to large deployments we recommend
    PostgreSQL. If you don't want/need PostgreSQL, skip this section.
 
-These are the packages needed for Debian Jessie (stable)::
+These are the packages needed for PostgreSQL::
 
+    # Debian and co.
     sudo apt install postgresql python3-psycopg2
 
-These are the packages needed for an RPM-based system::
-
+    # Fedora and co.
     sudo dnf install postgresql postgresql-server python3-psycopg2
 
 Fedora and co. also requires that you initialize and start the
 PostgreSQL database with a few commands. The following commands are
 not needed on a Debian-based platform, however::
 
+    # Feora and co.
     sudo /usr/bin/postgresql-setup initdb
     sudo systemctl enable postgresql
     sudo systemctl start postgresql
@@ -176,10 +177,12 @@ The following command will create a system account with a username of
 If you are using a Debian-based system, enter this command::
 
     # Debian and co.
-    sudo useradd --system --create-home --home-dir /var/lib/mediagoblin --group www-data --comment 'GNU MediaGoblin system account' mediagoblin
+    sudo useradd --system --create-home --home-dir /var/lib/mediagoblin \
+    --group www-data --comment 'GNU MediaGoblin system account' mediagoblin
 
     # Fedora and co.
-    sudo useradd --system --create-home --home-dir /var/lib/mediagoblin --group nginx --comment 'GNU MediaGoblin system account' mediagoblin
+    sudo useradd --system --create-home --home-dir /var/lib/mediagoblin \
+    --group nginx --comment 'GNU MediaGoblin system account' mediagoblin
 
 This will create a ``mediagoblin`` user and assign it to a group that is
 associated with the web server. This will ensure that the web server can
@@ -307,7 +310,7 @@ Configure MediaGoblin to use the PostgreSQL database
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If you are using PostgreSQL, edit the ``[mediagoblin]`` section in your
-``mediagoblin.ini`` and remove the `# ` prefix on the line containing::
+``mediagoblin.ini`` and remove the ``#`` prefix on the line containing::
 
     sql_engine = postgresql:///mediagoblin
 
@@ -600,7 +603,7 @@ Great job!
 
    This configuration supports upload of images only, but MediaGoblin
    also supports other types of media, such as audio, video, PDFs and
-   3D models. For details, see ":doc:`media-types-chapter`".
+   3D models. For details, see ":doc:`media-types`".
 
 ..
    Local variables:

diff --git a/docs/source/siteadmin/plugins.rst b/docs/source/siteadmin/plugins.rst
index 8682b0c751b323a77d82143b765a152fa9413940..0b3285b6310f89d52fca50fe9abe4a73c4a701da 100644 (file)
--- a/docs/source/siteadmin/plugins.rst
+++ b/docs/source/siteadmin/plugins.rst
@@ -49,13 +49,13 @@ offer for your media), we would do::
 
     pip install mediagoblin-licenses
 
-.. Note::
+.. 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. Also make sure, you use e.g. pip-2.7 if your default
-   python (and thus pip) is python 3 (e.g. in *buntu).
+   python (and thus pip) is python 3 (e.g. in Ubuntu and derivatives).
 
 Once you've installed the plugin software, you need to tell
 MediaGoblin that this is a plugin you want MediaGoblin to use. To do

diff --git a/docs/source/siteadmin/relnotes.rst b/docs/source/siteadmin/relnotes.rst
index ccf7521df851f6d092bf44f827daef58d75a2c72..c4f308e8458b8cebc9936e956ff15dbda5a2ff7b 100644 (file)
--- a/docs/source/siteadmin/relnotes.rst
+++ b/docs/source/siteadmin/relnotes.rst
@@ -51,6 +51,8 @@ be difficult for some people.
 TODO: Should we remove the ./configure to avoid inadvertently moving people from
 Python 2 to Python 3?
 
+TODO: Advice for upgrading to Python 3 - start from top of install guide.
+
 0. Update to the latest release.  In your ``mediagoblin`` directory, run:
    ``git fetch && git checkout -q v0.10.0``
 1. Run