summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Pasquier <spasquier@mirantis.com>2015-12-07 17:30:30 +0100
committerSimon Pasquier <spasquier@mirantis.com>2015-12-09 16:58:15 +0000
commitafb2dfaa279b270a6ad5cf5573aba8e90436b7de (patch)
tree274b6a6523c5918287127694b826f51d6105924d
parent3d3c6f9ccd58e2560f939378c2284d5b467c743c (diff)
Adjust documentation for PDF0.8.0
This change wraps lines when needed and tunes the configuration for PDF generation. Change-Id: Ia483681e196aea4c6e291231131ab0447a586aef (cherry picked from commit 45fcf4ff2a4a660a430f207fd1c5203ff38179f2)
Notes
Notes (review): Verified+2: Jenkins Code-Review+2: Simon Pasquier <spasquier@mirantis.com> Workflow+1: Simon Pasquier <spasquier@mirantis.com> Verified+1: Plugins CI <plugins.ci@mirantis.com> Submitted-by: Jenkins Submitted-at: Wed, 09 Dec 2015 17:11:36 +0000 Reviewed-on: https://review.openstack.org/255380 Project: openstack/fuel-plugin-lma-collector Branch: refs/heads/stable/0.8
-rw-r--r--doc/source/conf.py5
-rw-r--r--doc/source/dev/outputs.rst4
-rw-r--r--doc/source/user/alarms.rst3
-rw-r--r--doc/source/user/installation.rst5
4 files changed, 13 insertions, 4 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 54031bb..19a41b3 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -261,3 +261,8 @@ texinfo_documents = [
261 261
262# If true, do not generate a @detailmenu in the "Top" node's menu. 262# If true, do not generate a @detailmenu in the "Top" node's menu.
263#texinfo_no_detailmenu = False 263#texinfo_no_detailmenu = False
264
265# make latex stop printing blank pages between sections
266# http://stackoverflow.com/questions/5422997/sphinx-docs-remove-blank-pages-from-generated-pdfs
267latex_elements = {'classoptions': ',openany,oneside', 'babel':
268 '\\usepackage[english]{babel}'}
diff --git a/doc/source/dev/outputs.rst b/doc/source/dev/outputs.rst
index c2cd2ce..6235116 100644
--- a/doc/source/dev/outputs.rst
+++ b/doc/source/dev/outputs.rst
@@ -55,7 +55,9 @@ For instance, lets take the following Heka message::
55 :Pid: 15595 55 :Pid: 15595
56 :Uuid: e67f91c5-259b-489f-adfa-8eea0b389eb2 56 :Uuid: e67f91c5-259b-489f-adfa-8eea0b389eb2
57 :Logger: collectd 57 :Logger: collectd
58 :Payload: {"type":"cpu","values":[0],"type_instance":"idle","dsnames":["value"],"plugin":"cpu","time":1442333737.646,"interval":10,"host":"node-1","dstypes":["derive"],"plugin_instance":"0"} 58 :Payload: {"type":"cpu","values":[0],"type_instance":"idle","dsnames":["value"],
59 "plugin":"cpu","time":1442333737.646,"interval":10,"host":"node-1",
60 "dstypes":["derive"],"plugin_instance":"0"}
59 :EnvVersion: 61 :EnvVersion:
60 :Severity: 6 62 :Severity: 6
61 :Fields: 63 :Fields:
diff --git a/doc/source/user/alarms.rst b/doc/source/user/alarms.rst
index d3a0b27..a2020e3 100644
--- a/doc/source/user/alarms.rst
+++ b/doc/source/user/alarms.rst
@@ -387,7 +387,8 @@ defines the default status in case none of the previous rules could be matched.
387 387
388A policy rule is defined as shown in the example below:: 388A policy rule is defined as shown in the example below::
389 389
390 # The following rule definition reads as: "the cluster's status is critical if more than 50% of its members are either down or criticial" 390 # The following rule definition reads as: "the cluster's status is critical
391 # if more than 50% of its members are either down or criticial"
391 - status: critical 392 - status: critical
392 trigger: 393 trigger:
393 logical_operator: or 394 logical_operator: or
diff --git a/doc/source/user/installation.rst b/doc/source/user/installation.rst
index 13ace59..7df5a42 100644
--- a/doc/source/user/installation.rst
+++ b/doc/source/user/installation.rst
@@ -30,7 +30,8 @@ Catalog, you need to follow these steps:
30 30
312. Copy the RPM file to the Fuel Master node:: 312. Copy the RPM file to the Fuel Master node::
32 32
33 [root@home ~]# scp lma_collector-0.8-0.8.0-1.noarch.rpm root@<Fuel Master node IP address>: 33 [root@home ~]# scp lma_collector-0.8-0.8.0-1.noarch.rpm \
34 root@<Fuel Master node IP address>:
34 35
353. Install the plugin using the `Fuel CLI <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#using-fuel-cli>`_:: 363. Install the plugin using the `Fuel CLI <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#using-fuel-cli>`_::
36 37
@@ -91,4 +92,4 @@ if you need further instructions about how to build the Fuel Plugin Builder.
91 92
927. Now that you have created the RPM file, you can install the plugin using the `fuel plugins --install` command:: 937. Now that you have created the RPM file, you can install the plugin using the `fuel plugins --install` command::
93 94
94 [root@fuel ~] fuel plugins --install ./fuel-plugin-lma_collector/lma_collector-0.8-0.8.0-1.noarch.rpm 95 [root@fuel ~] fuel plugins --install ./fuel-plugin-lma_collector/*.noarch.rpm