Fix typos and bad links in the documentation

Change-Id: I30004d00a9f5fff75c661d13095fed54cdadafba
This commit is contained in:
Simon Pasquier 2016-03-17 14:53:22 +01:00
parent 154becde9a
commit 0207b86c60
4 changed files with 10 additions and 13 deletions

View File

@ -22,7 +22,7 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
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)))
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

View File

@ -57,7 +57,7 @@ The health status of a cluster is inferred by the GSE plugins using
aggregation and correlation rules and facts contained in the
*AFD metrics* it received from the Collectors.
In the current version of the LMA Toolchain, there are three :ref:`gse_plugins`:
In the current version of the LMA Toolchain, there are three :ref:`GSE plugins <gse_plugins>`:
* The Service Cluster GSE which receives metrics from the AFD plugins monitoring
the services and emits health status for the clusters of services (nova-api, nova-scheduler and so forth).
@ -102,7 +102,7 @@ The *AFD metrics* and *GSE metrics* are new types of metrics introduced
in LMA v 0.8. They contain detailed information about the entities
being monitored.
Please refer to the `Metrics section of the Developer Guide
<http://fuel-plugin-lma-collector.readthedocs.org/en/latest/dev/metrics.html>`_
<http://fuel-plugin-lma-collector.readthedocs.org/en/latest/appendix_b.html>`_
for further information about the structure of those messages.
Any backend system that has a *Persister* plugged
@ -149,8 +149,7 @@ as shown in the example below::
periods: 0
function: min
Where:
~~~~~~
**Where**
| name:
| Type: unicode
@ -209,8 +208,6 @@ Where:
| The number of prior time-series analysis window to compare the window with (this is
| not implemented yet)
.. _alarm_functions:
| function
| Type: enum('last' | 'min' | 'max' | 'sum' | 'count' | 'avg' | 'median' | 'mode' | 'roc' | 'mww' | 'mww_nonparametric')
| Where:

View File

@ -9,6 +9,6 @@ Appendix A: References
* The `LMA Infrastructure Alerting plugin <https://github.com/openstack/fuel-plugin-lma-Infrastructure-alerting>`_ project at GitHub.
* The official `Kibana documentation <https://www.elastic.co/guide/en/kibana/3.0/index.html>`_.
* The official `Elasticsearch documentation <https://www.elastic.co/guide/en/elasticsearch/reference/1.4/index.html>`_.
* The official `InfluxDB documentation <https://influxdb.com/docs/v0.9/introduction/overview.html>`_.
* The official `Grafana documentation <http://docs.grafana.org/v2.1/>`_.
* The official `InfluxDB documentation <https://docs.influxdata.com/influxdb/v0.10/>`_.
* The official `Grafana documentation <http://docs.grafana.org/v2.6/>`_.
* The official `Nagios documentation <https://www.nagios.org/documentation/>`_.

View File

@ -18,7 +18,7 @@ To configure your plugin, you need to follow these steps:
Alerting (LMA) Collector Plugin' section. You should see a page like this.
.. image:: ../../images/collector_settings.png
:scale: 50 %
:width: 350pt
:alt: The LMA Collector settings
:align: center
@ -26,7 +26,7 @@ To configure your plugin, you need to follow these steps:
fill-in the required fields as indicated below.
a. Provide an 'Environment Label' of your choice to tag your data (optional).
b. For the 'Events Analytics' destination, select 'Local node' if you plan to use the
b. For the 'Events Analytics' destination, select 'Local node' if you plan to use the
Elasticsearch-Kibana Plugin in this environment. Otherwise, select 'Remote server'
and specify the fully qualified name or IP address of an external Elasticsearch server.
c. For the 'Metrics Analytics' destination, select 'Local node' if you plan to use the
@ -35,13 +35,13 @@ To configure your plugin, you need to follow these steps:
InfluxDB database name you want to use, a username and password that has read and write
access permissions.
d. For 'Alerting', select 'Alerts sent by email' if you want to receive alerts sent by email
from the Collector. Otherwise, select 'Alerts sent to a local node' if you plan to
from the Collector. Otherwise, select 'Alerts sent to a local cluster' if you plan to
use the Infrastructure Alerting Plugin in this environment.
Alternatively, you can select 'Alerts sent to a remote Nagios server'.
e. For 'Alerts sent by email', you can specify the SMTP authentication method you want to use. Then,
specify the SMTP server fully qualified name or IP address, the SMTP username and password who
have the permissions to send emails.
f. Finally, specify the Nagios server URL, username and password if you have chosen to send
f. Finally, specify the Nagios server URL, username and password if you have chosen to send
alerts to an external Nagios server.
5. `Configure your environment <http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#configure-your-environment>`_ as needed.