From 932fdfbd70abda47ddea477c392188d6d9cb69ad Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Thu, 27 Dec 2018 16:59:48 -0800 Subject: [PATCH] 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 --- api-ref/source/index.rst | 9 ++++++--- doc/source/index.rst | 15 +++------------ releasenotes/source/index.rst | 3 +-- 3 files changed, 10 insertions(+), 17 deletions(-) diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index b8f9033f..2ed128f9 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -2,11 +2,14 @@ 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 `. + +API Reference +------------- .. toctree:: :maxdepth: 2 api-ref-fm-v1-fault - -:ref:`search` diff --git a/doc/source/index.rst b/doc/source/index.rst index eae6370d..cb1db0b5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,11 +1,8 @@ +======================= stx-fault Documentation ======================= -StarlingX Fault Management - -.. toctree:: - :maxdepth: 2 - :caption: Contents: +This is the documentation for StarlingX fault management. Release Notes ------------- @@ -24,7 +21,7 @@ API Reference API Reference Links -===== +----- * Source: `stx-fault`_ * Code Review: `Gerrit`_ @@ -33,9 +30,3 @@ Links .. _stx-fault: https://git.starlingx.io/cgit/stx-fault/ .. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-fault .. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-fault - -Indices and Tables -================== - -* :ref:`search` -* :ref:`genindex` diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index 4f6d00c8..73c9e131 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,3 +1,4 @@ +======================= stx-fault Release Notes ======================= @@ -5,5 +6,3 @@ stx-fault Release Notes :maxdepth: 2 unreleased - -:ref:`search`