Aligned overview section with the other plugins

Fixed drawing caption
Added support for SVG files generation in PDF

Change-Id: I51dc8e5b05171e9908e20bc168038f85e5293702
This commit is contained in:
Patrick Petit 2015-11-18 18:23:03 +01:00 committed by Simon Pasquier
parent 3f74538d5d
commit 16d2ec855d
4 changed files with 20 additions and 4 deletions

1
doc/.gitignore vendored
View File

@ -1 +1,2 @@
build/
images/*.pdf

View File

@ -18,6 +18,11 @@ PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# SVG to PDF conversion
SVG2PDF = inkscape
SVG2PDF_FLAGS =
# Build a list of SVG files to convert to PDF
PDF_FILES := $(foreach dir, images, $(patsubst %.svg,%.pdf,$(wildcard $(dir)/*.svg)))
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
@ -48,6 +53,7 @@ help:
clean:
rm -rf $(BUILDDIR)/*
rm -f $(PDF_FILES)
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

Binary file not shown.

After

Width:  |  Height:  |  Size: 106 KiB

View File

@ -3,9 +3,15 @@
Overview
========
The **LMA Infrastructure Alerting** plugin is used to install and configure
Nagios which provides the alerting functionality for the OpenStack
Infrastructure inside the LMA toolchain.
The **LMA Infrastructure Alerting Plugin** is used to install and configure
Nagios which provides the alerting and escalation functionalities of the LMA
Toolchain.
Nagios is a key component of the `LMA Toolchain project <https://launchpad.net/lma-toolchain>`_
as shown in the figure below.
.. image:: ../images/toolchain_map.*
:align: center
.. _plugin_requirements:
@ -28,4 +34,7 @@ Requirements
Limitations
-----------
None so far.
A current limitation of this plugin is that it not possible to display in the Fuel web UI,
the URL where the Nagios interface can be reached when the deployment has completed.
Instructions are provided in the :ref:`user_guide` about how you can
obtain this URL using the `fuel` command line.