From af555b6c1713fdf98411525c68da68e46cc9424b Mon Sep 17 00:00:00 2001
From: Martijn Vermaat <martijn@vermaat.name>
Date: Mon, 26 Oct 2015 11:34:56 +0100
Subject: [PATCH] Highlight Ansible Mutalyzer role in docs
---
README.rst | 5 +++++
doc/deploy.rst | 4 ++++
doc/index.rst | 3 +++
doc/install.rst | 4 ++++
mutalyzer/website/templates/about.html | 7 +++++++
5 files changed, 23 insertions(+)
diff --git a/README.rst b/README.rst
index 996520f0..540bc7cc 100644
--- a/README.rst
+++ b/README.rst
@@ -15,6 +15,11 @@ submit bug reports and feature requests.
Developer documentation is `hosted at Read The Docs
<http://mutalyzer.readthedocs.org>`_.
+If you're interested in running your own Mutalyzer installation, please have a
+look at our `Mutalyzer Ansible role
+<https://github.com/mutalyzer/ansible-role-mutalyzer>`_ for a completely
+automated deployment.
+
Contributing
------------
diff --git a/doc/deploy.rst b/doc/deploy.rst
index c1647f4f..ab75f0e8 100644
--- a/doc/deploy.rst
+++ b/doc/deploy.rst
@@ -18,6 +18,8 @@ containers such as `Gunicorn`_.
Below we briefly describe our recommended setup for a production environment
using Gunicorn, nginx and Supervisor.
+See :ref:`deploy_ansible` for a solution to completely automate this.
+
Configuration settings
----------------------
@@ -152,6 +154,8 @@ website:
environment=MUTALYZER_SETTINGS="/opt/mutalyzer/conf/settings.py"
+.. _deploy_ansible:
+
Automated deployment with Ansible
---------------------------------
diff --git a/doc/index.rst b/doc/index.rst
index 122f99ec..1fb9a74f 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -4,6 +4,9 @@ Mutalyzer developer documentation
Mutalyzer is an HGVS variant nomenclature checker. The canonical Mutalyzer
installation can be found at `mutalyzer.nl <https://mutalyzer.nl>`_.
+.. note:: If you're looking into running your own Mutalyzer installation, you
+ might be interested in :ref:`deploy_ansible`.
+
This is the developer documentation for Mutalyzer. User documentation can be
found on the `wiki <https://humgenprojects.lumc.nl/trac/mutalyzer>`_.
diff --git a/doc/install.rst b/doc/install.rst
index c070d0fa..35fdbaad 100644
--- a/doc/install.rst
+++ b/doc/install.rst
@@ -5,6 +5,10 @@
Installation
============
+.. note:: If you're looking into deploying Mutayzer in a production
+ environment (as opposed to a local development installation), please see
+ :ref:`deploy`.
+
Mutalyzer depends on a database server, `Python`_ 2.7, and several Python
packages. `Redis`_ is a soft dependency. This section walks you through
installing Mutalyzer with Redis and using `PostgreSQL`_ as database server,
diff --git a/mutalyzer/website/templates/about.html b/mutalyzer/website/templates/about.html
index d6ef86be..0e16c0c2 100644
--- a/mutalyzer/website/templates/about.html
+++ b/mutalyzer/website/templates/about.html
@@ -70,6 +70,13 @@ Development of Mutalyzer happens on
GitHub: <a href="https://github.com/mutalyzer/mutalyzer">github.com/mutalyzer/mutalyzer</a>
</p>
+<p>
+If you're interested in running your own Mutalyzer installation, please have a
+look at
+our <a href="https://github.com/mutalyzer/ansible-role-mutalyzer">Mutalyzer
+Ansible role</a> for a completely automated deployment.
+</p>
+
<h2>Sponsors</h2>
<p>
--
GitLab