From c0f62b4c9512e20434abe9f38dfc5a68f83a50cf Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Thu, 27 Dec 2018 16:56:44 -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) releasenotes index.rst: 1. Standardize page title reST markup 2. Remove search (make consistent with other openstack release note pages) Story: 2004737 Task: 28804 Change-Id: I395a15a2cfde2ceaf7f7e203eb48e02a11394af0 Signed-off-by: Kristal Dale --- doc/source/index.rst | 16 ++++------------ releasenotes/source/index.rst | 3 +-- 2 files changed, 5 insertions(+), 14 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 48133c6..59deab5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,11 +1,9 @@ +================================== stx-distcloud-client Documentation ================================== -StarlingX Distributed Cloud Client - -.. toctree:: - :maxdepth: 2 - :caption: Contents: +The StarlingX stx-distcloud-client project provides client functionality +for StarlingX distributed cloud. Release Notes ------------- @@ -16,7 +14,7 @@ Release Notes Release Notes Links -===== +----- * Source: `stx-distcloud-client`_ * Code Review: `Gerrit`_ @@ -25,9 +23,3 @@ Links .. _stx-distcloud-client: https://git.starlingx.io/cgit/stx-distcloud-client/ .. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-distcloud-client .. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-distcloud-client - -Indices and Tables -================== - -* :ref:`search` -* :ref:`genindex` diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index 284609f..dd44d82 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,3 +1,4 @@ +================================== stx-distcloud-client Release Notes ================================== @@ -5,5 +6,3 @@ stx-distcloud-client Release Notes :maxdepth: 2 unreleased - -:ref:`search`