Doc Migration: move the developer guide documents under the "contributor" folder

Changed files:
- index.rst
- contributor/index.rst
- installation-and-configuration - split to devstack-installation.rst and configuration.rst

Change-Id: I4683a213e2a530d2088c4f232b9c2508fc25ba68
This commit is contained in:
Ifat Afek 2017-07-25 07:55:28 +00:00
parent 00e1d302a3
commit 5d40367bef
39 changed files with 62 additions and 63 deletions

View File

@ -0,0 +1,14 @@
=====================
Vitrage configuration
=====================
.. toctree::
:maxdepth: 1
nagios-config
static-config
static-physical-config
resource-state-config
alarm-severity-config
zabbix_vitrage
notifier-snmp-plugin

View File

@ -0,0 +1,21 @@
=====================
Devstack Installation
=====================
Vitrage Devstack Installation
=============================
* `Enabling Vitrage in devstack <https://github.com/openstack/vitrage/blob/master/devstack/README.rst>`_
* `Enabling Vitrage in horizon <https://github.com/openstack/vitrage-dashboard/blob/master/README.rst>`_
External Monitor Installation
=============================
To install Nagios or Zabbix external monitors:
.. toctree::
:maxdepth: 1
nagios-devstack-installation
zabbix_vitrage

View File

Before

Width:  |  Height:  |  Size: 200 KiB

After

Width:  |  Height:  |  Size: 200 KiB

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

Before

Width:  |  Height:  |  Size: 217 KiB

After

Width:  |  Height:  |  Size: 217 KiB

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

View File

Before

Width:  |  Height:  |  Size: 229 KiB

After

Width:  |  Height:  |  Size: 229 KiB

View File

Before

Width:  |  Height:  |  Size: 212 KiB

After

Width:  |  Height:  |  Size: 212 KiB

View File

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

Before

Width:  |  Height:  |  Size: 193 KiB

After

Width:  |  Height:  |  Size: 193 KiB

View File

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

View File

Before

Width:  |  Height:  |  Size: 98 KiB

After

Width:  |  Height:  |  Size: 98 KiB

View File

Before

Width:  |  Height:  |  Size: 263 KiB

After

Width:  |  Height:  |  Size: 263 KiB

View File

@ -0,0 +1,5 @@
Developer's Reference
=====================
.. toctree::
:maxdepth: 1

View File

@ -26,7 +26,7 @@ High Level Functionality
High Level Architecture High Level Architecture
----------------------- -----------------------
.. image:: ./images/vitrage_graph_architecture.png .. image:: ./contributor/images/vitrage_graph_architecture.png
:width: 100% :width: 100%
:align: center :align: center
@ -62,13 +62,22 @@ Installation Guide
Developer Guide Developer Guide
--------------- ---------------
.. # NOTE(ifat-afek): Hide files we don't want to see in the table of contents.
# sphinx build fails if a file is not included in the toctree.
.. toctree::
:hidden:
contributor/index
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
vitrage-first_steps contributor/vitrage-first_steps
vitrage-api contributor/vitrage-api
vitrage-template-format contributor/vitrage-template-format
installation-and-configuration contributor/devstack-installation
contributor/configuration
profiler-config
Design Documents Design Documents
---------------- ----------------
@ -76,10 +85,10 @@ Design Documents
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
vitrage-graph-design contributor/vitrage-graph-design
scenario-evaluator contributor/scenario-evaluator
vitrage-use-cases contributor/vitrage-use-cases
add-new-datasource contributor/add-new-datasource
not_operator_support contributor/not_operator_support
templates-loading contributor/templates-loading
vitrage-ha-and-history-vision contributor/vitrage-ha-and-history-vision

View File

@ -1,50 +0,0 @@
==============================
Installation and configuration
==============================
Vitrage Installation
====================
To Install Vitrage, use **either** devstack installation or manual installation
--------------------------
Enable Vitrage in Devstack
--------------------------
* `Enabling Vitrage in devstack <https://github.com/openstack/vitrage/blob/master/devstack/README.rst>`_
* `Enabling Vitrage in horizon <https://github.com/openstack/vitrage-dashboard/blob/master/README.rst>`_
---------------------------------------------------
Manual Installation of Vitrage (not using Devstack)
---------------------------------------------------
.. toctree::
:maxdepth: 1
install/index
External Monitor Installation
=============================
To install Nagios or Zabbix external monitors:
.. toctree::
:maxdepth: 1
nagios-devstack-installation
zabbix_vitrage
Configuration
=============
.. toctree::
:maxdepth: 1
nagios-config
static-config
static-physical-config
resource-state-config
alarm-severity-config
zabbix_vitrage
notifier-snmp-plugin
profiler-config

View File

@ -52,7 +52,7 @@ class BaseAlarmsTest(BaseApiTest):
self._wait_for_status(20, self._wait_for_status(20,
self._check_num_alarms, self._check_num_alarms,
num_alarms=0) num_alarms=0)
time.sleep(25) time.sleep(120)
@staticmethod @staticmethod
def _aodh_request(resource_id=None, name=None): def _aodh_request(resource_id=None, name=None):