From 6cd39f8226b84c2321d0040cd6b94f8df548485a Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Thu, 27 Dec 2018 16:53:38 -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) Story: 2004737 Task: 28803 Change-Id: I11ba3784a5d50953d62f0bc4a08f3f2b308da6b5 Signed-off-by: Kristal Dale --- 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 f05e11777..8bc1ee901 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -2,11 +2,14 @@ stx-distcloud API Reference =========================== -StarlingX Distributed Cloud +Use the StarlingX stx-distcloud API to manage distributed cloud operations. + +stx-distcloud API content can be searched using the :ref:`search page `. + +API Reference +------------- .. toctree:: :maxdepth: 2 api-ref-dcmanager-v1 - -:ref:`search` diff --git a/doc/source/index.rst b/doc/source/index.rst index 4d35712ed..81fba22b3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,11 +1,9 @@ +=========================== stx-distcloud Documentation =========================== -StarlingX Distributed Cloud - -.. toctree:: - :maxdepth: 2 - :caption: Contents: +The StarlingX stx-distcloud project provides management for distributed +cloud operations. Release Notes ------------- @@ -24,7 +22,7 @@ API Reference API Reference Links -===== +----- * Source: `stx-distcloud`_ * Code Review: `Gerrit`_ @@ -33,9 +31,3 @@ Links .. _stx-distcloud: https://git.starlingx.io/cgit/stx-distcloud/ .. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-distcloud .. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-distcloud - -Indices and Tables -================== - -* :ref:`search` -* :ref:`genindex` diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index 858230f79..dfe8303d2 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,3 +1,4 @@ +=========================== stx-distcloud Release Notes =========================== @@ -5,5 +6,3 @@ stx-distcloud Release Notes :maxdepth: 2 unreleased - -:ref:`search`