From 53914fc55cfc62ee15793f32e626ed7322008d93 Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Fri, 17 Jan 2020 14:10:55 -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 - Update project name in link to release notes, api-ref - Update project name in config for docs/releasenotes/api-ref Story:2007193 Task:38350 Change-Id: I3c44012bc67136aed1e12c63037c822db7cdc4a6 Signed-off-by: Kristal Dale --- doc/source/conf.py | 2 +- doc/source/index.rst | 22 ++++++++++++---------- releasenotes/source/conf.py | 2 +- releasenotes/source/index.rst | 6 +++--- 4 files changed, 17 insertions(+), 15 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 7a73af5ea..63380a3ae 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,7 @@ # -- Project information ----------------------------------------------------- -project = u'stx-integ' +project = u'StarlingX Integration' copyright = u'2018, StarlingX' author = u'StarlingX' diff --git a/doc/source/index.rst b/doc/source/index.rst index 4ed07e495..e7fb720fe 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,24 +1,26 @@ -======================= -stx-integ Documentation -======================= +=================================== +StarlingX Integration Project +=================================== -This is the documentation for StarlingX integration and packaging. +The starlingx/integ project provides integration and packaging for StarlingX. -Release Notes +------------- +Release notes ------------- .. toctree:: :maxdepth: 1 - Release Notes + Release notes +----- Links ----- -* Source: `stx-integ`_ -* Code Review: `Gerrit`_ -* Bugs: `Storyboard`_ +* Source: `starlingx/integ`_ +* Code review: `Gerrit`_ +* Project tracking: `Storyboard`_ -.. _stx-integ: https://opendev.org/starlingx/integ +.. _starlingx/integ: https://opendev.org/starlingx/integ .. _Gerrit: https://review.opendev.org/#/q/project:starlingx/integ .. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/integ diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index ee30d0c17..e774ecb9f 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 = u'stx-integ' +project = u'StarlingX Integration' # 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 d0fded5ea..c27149e92 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,6 +1,6 @@ -======================= -stx-integ Release Notes -======================= +=================================== +StarlingX Integration Release Notes +=================================== .. toctree:: :maxdepth: 2