Fix some docs build warnings.

This commit is contained in:
Ben Sturmfels 2020-04-29 09:55:28 +10:00
parent 35494ed66c
commit 464a5d7fba
No known key found for this signature in database
GPG Key ID: 023C05E2C9C068F0
6 changed files with 23 additions and 18 deletions

View File

@ -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. be used in the future to represent lists/groups of users which you can send activities to.
Example Example
^^^^^^^ -------
A collection which contains two images:: A collection which contains two images::
{ {

View File

@ -53,7 +53,7 @@ redirect_uri
Response Response
^^^^^^^^ --------
You will get back a 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. This is time that the client credentials expire. If this is 0 the client registration does not expire.
Examples Examples
-------- ~~~~~~~~
Register Client Register Client
^^^^^^^^^^^^^^^ ---------------
To register a client for the first time, this is the minimum you must supply:: 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 Updating Client
^^^^^^^^^^^^^^^ ---------------
Using the response we got above we can update the information and add new information we may have opted not to supply:: 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 Possible Registration Errors
---------------------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are a number of errors you could get back, This explains what could cause some of them: There are a number of errors you could get back, This explains what could cause some of them:

View File

@ -11,7 +11,7 @@
Dedication along with this software. If not, see Dedication along with this software. If not, see
<http://creativecommons.org/publicdomain/zero/1.0/>. <http://creativecommons.org/publicdomain/zero/1.0/>.
.. info:: Currently only image uploading is supported. .. note:: Currently only image uploading is supported.
======= =======
Objects Objects

View File

@ -17,7 +17,7 @@
Deploying MediaGoblin 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. setting up your own instance of MediaGoblin.
MediaGoblin most likely isn't yet available from your operating 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 config-manager --set-enabled PowerTools
sudo dnf install rabbitmq-server sudo dnf install rabbitmq-server
sudo systemctl enable rabbitmq-server.service 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 As an alternative, you can try installing redis-server and
configure it as celery broker. configure it as celery broker.
@ -119,18 +119,19 @@ Configure PostgreSQL
deployments. For medium to large deployments we recommend deployments. For medium to large deployments we recommend
PostgreSQL. If you don't want/need PostgreSQL, skip this section. 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 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 sudo dnf install postgresql postgresql-server python3-psycopg2
Fedora and co. also requires that you initialize and start the Fedora and co. also requires that you initialize and start the
PostgreSQL database with a few commands. The following commands are PostgreSQL database with a few commands. The following commands are
not needed on a Debian-based platform, however:: not needed on a Debian-based platform, however::
# Feora and co.
sudo /usr/bin/postgresql-setup initdb sudo /usr/bin/postgresql-setup initdb
sudo systemctl enable postgresql sudo systemctl enable postgresql
sudo systemctl start 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:: If you are using a Debian-based system, enter this command::
# Debian and co. # 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. # 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 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 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 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 sql_engine = postgresql:///mediagoblin
@ -600,7 +603,7 @@ Great job!
This configuration supports upload of images only, but MediaGoblin This configuration supports upload of images only, but MediaGoblin
also supports other types of media, such as audio, video, PDFs and 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: Local variables:

View File

@ -49,13 +49,13 @@ offer for your media), we would do::
pip install mediagoblin-licenses pip install mediagoblin-licenses
.. Note:: .. note::
If you're using a virtual environment, make sure to activate the If you're using a virtual environment, make sure to activate the
virtual environment before installing with pip. Otherwise the plugin virtual environment before installing with pip. Otherwise the plugin
may get installed in a different environment than the one MediaGoblin 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 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 Once you've installed the plugin software, you need to tell
MediaGoblin that this is a plugin you want MediaGoblin to use. To do MediaGoblin that this is a plugin you want MediaGoblin to use. To do

View File

@ -51,6 +51,8 @@ be difficult for some people.
TODO: Should we remove the ./configure to avoid inadvertently moving people from TODO: Should we remove the ./configure to avoid inadvertently moving people from
Python 2 to Python 3? 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: 0. Update to the latest release. In your ``mediagoblin`` directory, run:
``git fetch && git checkout -q v0.10.0`` ``git fetch && git checkout -q v0.10.0``
1. Run 1. Run