From 3522ead3016c7f5b735541ac7ab4e027412d21ad Mon Sep 17 00:00:00 2001
From: Kristal Dale <kristal.dale@intel.com>
Date: Thu, 27 Dec 2018 17:08:17 -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)

Story: 2004737
Task: 28805

Change-Id: I388cc5d69db56e6e94bf034ece2478933c9d9c1e
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
---
 api-ref/source/index.rst      |  9 ++++++---
 doc/source/index.rst          | 16 ++++------------
 releasenotes/source/index.rst |  3 +--
 3 files changed, 11 insertions(+), 17 deletions(-)

diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst
index f16f3ef7..d16806b4 100644
--- a/api-ref/source/index.rst
+++ b/api-ref/source/index.rst
@@ -2,11 +2,14 @@
 stx-metal API Reference
 =======================
 
-This is the API Reference for the StarlingX Bare Metal and Node Management, Hardware Maintenance.
+Use the StarlingX stx-metal API to maintain and manage physical hosts.
+
+stx-metal API content can be searched using the :ref:`search page <search>`.
+
+API Reference
+-------------
 
 .. toctree::
    :maxdepth: 2
 
    api-ref-sysinv-v1-metal
-
-:ref:`search`
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 2fc31382..71f59240 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,11 +1,9 @@
+=======================
 stx-metal Documentation
 =======================
 
-StarlingX Bare Metal and Node Management, Hardware Maintenance.
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+The StarlingX stx-metal project provides physical host maintenance and
+management.
 
 Release Notes
 -------------
@@ -24,7 +22,7 @@ API Reference
    API Reference <https://docs.starlingx.io/api-ref/stx-metal>
 
 Links
-=====
+-----
 
 * Source: `stx-metal`_
 * Code Review: `Gerrit`_
@@ -33,9 +31,3 @@ Links
 .. _stx-metal: https://git.starlingx.io/cgit/stx-metal/
 .. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-metal
 .. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-metal
-
-Indices and Tables
-==================
-
-* :ref:`search`
-* :ref:`genindex`
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index a4184a4e..151cdc5b 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -1,3 +1,4 @@
+=======================
 stx-metal Release Notes
 =======================
 
@@ -5,5 +6,3 @@ stx-metal Release Notes
    :maxdepth: 2
 
    unreleased
-
-:ref:`search`