From 6d53febf34e46fb44a5783718fd5cf28931f8bea Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Wed, 15 Jan 2020 14:42:24 -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:38336 Change-Id: Ia01582558ab27accb68ccdf00d492f5e79689f04 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 84cf9db4d6..d751fec22e 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-config' -project = u'stx-config' +project = u'StarlingX Configuration' bug_project = 'starlingx' bug_tag = 'stx.config' diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 75a39cf6c4..f2b3ad36c9 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -1,12 +1,13 @@ -======================== -stx-config API Reference -======================== +=========================== +Configuration API Reference +=========================== -Use the StarlingX stx-config API for system configuration management. +Use the StarlingX Configuration API for system configuration management. -stx-config API content can be searched using the :ref:`search page `. +Search Configuration 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 2efaeefba1..e272002e86 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -21,7 +21,7 @@ # -- Project information ----------------------------------------------------- -project = u'stx-config' +project = u'StarlingX Configuration' copyright = u'2018, StarlingX' author = u'StarlingX' diff --git a/doc/source/index.rst b/doc/source/index.rst index dc4c43f426..eb7020e1a0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,32 +1,35 @@ -======================== -stx-config Documentation -======================== +=============================== +StarlingX Configuration Project +=============================== -This is the documentation for StarlingX system configuration management. +The starlingx/config project provides system configuration management. -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-config`_ -* Code Review: `Gerrit`_ -* Bugs: `Storyboard`_ +* Source: `starlingx/config`_ +* Code review: `Gerrit`_ +* Project tracking: `Storyboard`_ -.. _stx-config: https://opendev.org/starlingx/config/ +.. _starlingx/config: https://opendev.org/starlingx/config/ .. _Gerrit: https://review.opendev.org/#/q/project:starlingx/config .. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/config diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 5d45135ea4..7e81f4d4fb 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-config' +project = u'StarlingX Configuration' # 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 ad0b35bc85..45a8567a00 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,6 +1,6 @@ -======================== -stx-config Release Notes -======================== +===================================== +StarlingX Configuration Release Notes +===================================== .. toctree:: :maxdepth: 2