From 7756b4cfb6fa9101b1a3ff32f74bb925e4f6d119 Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Fri, 17 Jan 2020 13:56:26 -0800 Subject: [PATCH] Update landing pages for docs, api-ref, 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 - Update project name in link to release notes, api-ref - Update project name in config for docs/releasenotes/api-ref Story:2007193 Task:38348 Change-Id: I4840bfb9c17128e1883e36b8292ce325045b618a Signed-off-by: Kristal Dale --- api-ref/source/conf.py | 2 +- api-ref/source/index.rst | 13 +++++++------ doc/source/conf.py | 2 +- doc/source/index.rst | 27 +++++++++++++++------------ releasenotes/source/conf.py | 2 +- releasenotes/source/index.rst | 6 +++--- 6 files changed, 28 insertions(+), 24 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 67918693..8f8c2539 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -51,7 +51,7 @@ master_doc = 'index' # General information about the project. repository_name = 'openstack/stx-ha' -project = u'stx-ha' +project = u'StarlingX HA' bug_project = 'starlingx' bug_tag = 'stx.ha' diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index a791138a..d742d9e1 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -1,13 +1,14 @@ -==================== -stx-ha API Reference -==================== +========================= +HA Services API Reference +========================= -Use the StarlingX stx-ha API to manage high availability services running +Use the StarlingX HA API to manage high availability services running on the StarlingX OpenStack controller cluster. -stx-ha API content can be searched using the :ref:`search page `. +Search HA Services API content using the :ref:`search page `. -API Reference +------------- +API reference ------------- .. toctree:: diff --git a/doc/source/conf.py b/doc/source/conf.py index efb3f438..ddf57249 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -21,7 +21,7 @@ # -- Project information ----------------------------------------------------- -project = u'stx-ha' +project = u'StarlingX HA' copyright = u'2018, StarlingX' author = u'StarlingX' diff --git a/doc/source/index.rst b/doc/source/index.rst index f5b53528..2bab4fda 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,33 +1,36 @@ -==================== -stx-ha Documentation -==================== +============================= +StarlingX HA Services Project +============================= -The StarlingX stx-ha project provides high availability cluster management +The starlingx/ha project provides high availability cluster management for StarlingX and OpenStack services on controllers. -Release Notes +------------- +Release notes ------------- .. toctree:: :maxdepth: 1 - Release Notes + Release notes -API Reference +------------- +API reference ------------- .. toctree:: :maxdepth: 1 - API Reference + API reference +----- Links ----- -* Source: `stx-ha`_ -* Code Review: `Gerrit`_ -* Bugs: `Storyboard`_ +* Source: `starlingx/ha`_ +* Code review: `Gerrit`_ +* Project tracking: `Storyboard`_ -.. _stx-ha: https://opendev.org/starlingx/ha +.. _starlingx/ha: https://opendev.org/starlingx/ha .. _Gerrit: https://review.opendev.org/#/q/project:starlingx/ha .. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/ha diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 953e1b75..d01ffcea 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -57,7 +57,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = 'stx-ha' +project = 'StarlingX HA' # 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 a3d41248..aca25997 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,6 +1,6 @@ -==================== -stx-ha Release Notes -==================== +=================================== +StarlingX HA Services Release Notes +=================================== .. toctree:: :maxdepth: 2