fault/api-ref/source/index.rst
Kristal Dale 932fdfbd70 Clean up and standardize landing pages
doc index.rst:
1. Update intro sentence to read as a complete sentence
2. Remove unused toctree
3. Correct heading levels (impacting side nav and correct rendering of content)
4. Remove "Indices and Tables" section: genindex page not used, search searches
only index (not useful here)

api-ref index.rst:
1. Update intro sentence to read as a complete sentence
2. Update text around search link for consistency (move to follow intro)
3. Add heading before toctree for consistency with other pages

releasenotes index.rst:
1. Standardize page title reST markup
2. Remove search (make consistent with other openstack release note pages)

Change-Id: I57d05e7a37997fa6941852d420cfed7e6c7c5ad6
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-12-27 16:59:48 -08:00

16 lines
320 B
ReStructuredText

=======================
stx-fault API Reference
=======================
Use the StarlingX stx-fault API for alarm and event collection of the cloud platform.
stx-fault API content can be searched using the :ref:`search page <search>`.
API Reference
-------------
.. toctree::
:maxdepth: 2
api-ref-fm-v1-fault