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>
This commit is contained in:
parent
f9ae82009b
commit
932fdfbd70
@ -2,11 +2,14 @@
|
|||||||
stx-fault API Reference
|
stx-fault API Reference
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
StarlingX Fault Management
|
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::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
api-ref-fm-v1-fault
|
api-ref-fm-v1-fault
|
||||||
|
|
||||||
:ref:`search`
|
|
||||||
|
@ -1,11 +1,8 @@
|
|||||||
|
=======================
|
||||||
stx-fault Documentation
|
stx-fault Documentation
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
StarlingX Fault Management
|
This is the documentation for StarlingX fault management.
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
:caption: Contents:
|
|
||||||
|
|
||||||
Release Notes
|
Release Notes
|
||||||
-------------
|
-------------
|
||||||
@ -24,7 +21,7 @@ API Reference
|
|||||||
API Reference <https://docs.starlingx.io/api-ref/stx-fault>
|
API Reference <https://docs.starlingx.io/api-ref/stx-fault>
|
||||||
|
|
||||||
Links
|
Links
|
||||||
=====
|
-----
|
||||||
|
|
||||||
* Source: `stx-fault`_
|
* Source: `stx-fault`_
|
||||||
* Code Review: `Gerrit`_
|
* Code Review: `Gerrit`_
|
||||||
@ -33,9 +30,3 @@ Links
|
|||||||
.. _stx-fault: https://git.starlingx.io/cgit/stx-fault/
|
.. _stx-fault: https://git.starlingx.io/cgit/stx-fault/
|
||||||
.. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-fault
|
.. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-fault
|
||||||
.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-fault
|
.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-fault
|
||||||
|
|
||||||
Indices and Tables
|
|
||||||
==================
|
|
||||||
|
|
||||||
* :ref:`search`
|
|
||||||
* :ref:`genindex`
|
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
=======================
|
||||||
stx-fault Release Notes
|
stx-fault Release Notes
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
@ -5,5 +6,3 @@ stx-fault Release Notes
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
unreleased
|
unreleased
|
||||||
|
|
||||||
:ref:`search`
|
|
||||||
|
Loading…
Reference in New Issue
Block a user