From 5e3f0fdfb7e5eeba6b9391d6c7fdbf4247ea281c Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Fri, 17 Jan 2020 14:04:53 -0800 Subject: [PATCH] Update landing pages for docs and release notes: - Use updated project name in titles/text - Correct text for link to Storyboard (docs) - Correct capitalization in section headings - Correct formatting for section headings - Add missing section (docs) to bring inline with other pages - Update project name in link to release notes - Update project name in config for docs/releasenotes Story:2007193 Task:38249 Change-Id: I3a336184cadf910bd66ce4d3349917fc530dcbde Signed-off-by: Kristal Dale --- doc/source/conf.py | 2 +- doc/source/index.rst | 29 ++++++++++++++++------------- releasenotes/source/conf.py | 2 +- releasenotes/source/index.rst | 5 +++-- 4 files changed, 21 insertions(+), 17 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index e43f0dc..9d88881 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,7 @@ # -- Project information ----------------------------------------------------- -project = u'stx-clients' +project = u'StarlingX Clients' copyright = u'2018, StarlingX' author = u'StarlingX' diff --git a/doc/source/index.rst b/doc/source/index.rst index d3bc0c2..24c2d3c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,25 +1,28 @@ -stx-clients Documentation +========================= +StarlingX Clients Project ========================= -StarlingX Client Libraries +The starlingx/clients project provides client libraries. + +------------- +Release notes +------------- .. toctree:: - :maxdepth: 2 - :caption: Contents: + :maxdepth: 1 + Release notes + +----- Links -===== +----- -* Source: `stx-clients`_ -* Code Review: `Gerrit`_ -* Bugs: `Storyboard`_ +* Source: `starlingx/clients`_ +* Code review: `Gerrit`_ +* Project tracking: `Storyboard`_ -.. _stx-clients: https://opendev.org/starlingx/clients +.. _starlingx/clients: https://opendev.org/starlingx/clients .. _Gerrit: https://review.opendev.org/#/q/project:starlingx/clients .. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/clients -Indices and Tables -================== -* :ref:`search` -* :ref:`genindex` diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 01761ba..eb21bf5 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -46,7 +46,7 @@ source_suffix = '.rst' # The master toctree document. master_doc = 'index' -project = 'stx-clients' +project = u'StarlingX Clients' # Release notes are version independent, no need to set version and release release = '' diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index 1a7173e..6ad63eb 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,5 +1,6 @@ -stx-clients Release Notes -========================= +=============================== +StarlingX Clients Release Notes +=============================== .. toctree:: :maxdepth: 2