From 54ed99eb3cf57788cdd7caeedb3d02883b99b01c Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Wed, 15 Jan 2020 15:23:45 -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:38342 Change-Id: I65d4b92deef90c09f7c1f309bf79e454c570c8a1 Signed-off-by: Kristal Dale --- api-ref/source/conf.py | 2 +- api-ref/source/index.rst | 14 ++++++++------ doc/source/conf.py | 2 +- doc/source/index.rst | 27 +++++++++++++++------------ releasenotes/source/conf.py | 3 +++ releasenotes/source/index.rst | 6 +++--- 6 files changed, 31 insertions(+), 23 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index ff897d2b3..bc17311df 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-distcloud' -project = u'stx-distcloud' +project = u'StarlingX Distributed Cloud' bug_project = 'starlingx' bug_tag = 'stx.distcloud' diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 8bc1ee901..8194f0f55 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -1,12 +1,14 @@ -=========================== -stx-distcloud API Reference -=========================== +=============================== +Distributed Cloud API Reference +=============================== -Use the StarlingX stx-distcloud API to manage distributed cloud operations. +Use the StarlingX Distributed Cloud API to manage distributed cloud +operations. -stx-distcloud API content can be searched using the :ref:`search page `. +Search Distributed Cloud 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 afada6241..c7af2a1a6 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -21,7 +21,7 @@ # -- Project information ----------------------------------------------------- -project = u'stx-distcloud' +project = u'StarlingX Distributed Cloud' copyright = u'2018, StarlingX' author = u'StarlingX' diff --git a/doc/source/index.rst b/doc/source/index.rst index 2c344bc68..98e7d38e0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,33 +1,36 @@ -=========================== -stx-distcloud Documentation -=========================== +=================================== +StarlingX Distributed Cloud Project +=================================== -The StarlingX stx-distcloud project provides management for distributed +The starlingx/distcloud project provides management for distributed cloud operations. -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-distcloud`_ -* Code Review: `Gerrit`_ -* Bugs: `Storyboard`_ +* Source: `starlingx/distcloud`_ +* Code review: `Gerrit`_ +* Project tracking: `Storyboard`_ -.. _stx-distcloud: https://opendev.org/starlingx/distcloud +.. _starlingx/distcloud: https://opendev.org/starlingx/distcloud .. _Gerrit: https://review.opendev.org/#/q/project:starlingx/distcloud .. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/distcloud diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index d82cf338a..b3de55acb 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -41,6 +41,9 @@ extensions = [ 'reno.sphinxext', ] +# General information about the project. +project = u'StarlingX Distributed Cloud' + bug_project = '1027' bug_tag = 'stx.bug' diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index dfe8303d2..38e63c575 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,6 +1,6 @@ -=========================== -stx-distcloud Release Notes -=========================== +========================================= +StarlingX Distributed Cloud Release Notes +========================================= .. toctree:: :maxdepth: 2