From 009bd77d7513ef754bd3d27e9e42fe3e1ce9b68f Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Thu, 27 Dec 2018 16:49:27 -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 release notes: 1. Standardize page title reST markup 2. Remove search (make consistent with other openstack release note pages) Change-Id: I0bbd0812f4f2132193724feb9b18910389dc85f4 Signed-off-by: Kristal Dale --- api-ref/source/index.rst | 12 ++++++------ doc/source/index.rst | 15 +++------------ releasenotes/source/index.rst | 6 +----- 3 files changed, 10 insertions(+), 23 deletions(-) diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 42918cb54e..75a39cf6c4 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -2,14 +2,14 @@ stx-config API Reference ======================== -StarlingX System Configuration Management +Use the StarlingX stx-config API for system configuration management. + +stx-config API content can be searched using the :ref:`search page `. + +API Reference +------------- .. toctree:: :maxdepth: 2 api-ref-sysinv-v1-config - -Search ------- - -:ref:`search` diff --git a/doc/source/index.rst b/doc/source/index.rst index 8c68bf68c0..ab0e51fc98 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,11 +1,8 @@ +======================== stx-config Documentation ======================== -StarlingX System Configuration Management - -.. toctree:: - :maxdepth: 2 - :caption: Contents: +This is the documentation for StarlingX system configuration management. Release Notes ------------- @@ -24,7 +21,7 @@ API Reference API Reference Links -===== +----- * Source: `stx-config`_ * Code Review: `Gerrit`_ @@ -33,9 +30,3 @@ Links .. _stx-config: https://git.starlingx.io/cgit/stx-config/ .. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-config .. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-config - -Indices and Tables -================== - -* :ref:`search` -* :ref:`genindex` diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index fd4092e544..ad0b35bc85 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,3 +1,4 @@ +======================== stx-config Release Notes ======================== @@ -5,8 +6,3 @@ stx-config Release Notes :maxdepth: 2 unreleased - -Search ------- - -:ref:`search`