From 333380daef7623eeb8eed16245d3700227d3003c Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Fri, 17 Jan 2020 13:30:49 -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:38347 Change-Id: I52a53260042e6924673230486476c394001683ca Signed-off-by: Kristal Dale --- doc/source/conf.py | 2 +- doc/source/index.rst | 18 ++++++++++-------- releasenotes/source/conf.py | 2 +- releasenotes/source/index.rst | 6 +++--- 4 files changed, 15 insertions(+), 13 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index ec96beb5..a4782d84 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,7 @@ # -- Project information ----------------------------------------------------- -project = u'stx-upstream' +project = u'StarlingX Upstream' copyright = u'2018, StarlingX' author = u'StarlingX' diff --git a/doc/source/index.rst b/doc/source/index.rst index 880a5211..882e6e8a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,24 +1,26 @@ ========================== -stx-upstream Documentation +StarlingX Upstream Project ========================== -This is the documentation for StarlingX upstream packaging. +The starlingx/upstream project provides upstream packaging. -Release Notes +------------- +Release notes ------------- .. toctree:: :maxdepth: 1 - Release Notes + Release notes +----- Links ----- -* Source: `stx-upstream`_ -* Code Review: `Gerrit`_ -* Bugs: `Storyboard`_ +* Source: `starlingx/upstream`_ +* Code review: `Gerrit`_ +* Project tracking: `Storyboard`_ -.. _stx-upstream: https://opendev.org/starlingx/upstream +.. _starlingx/upstream: https://opendev.org/starlingx/upstream .. _Gerrit: https://review.opendev.org/#/q/project:starlingx/upstream .. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/upstream diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 2d6cbc27..7494090a 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-upstream' +project = u'StarlingX Upstream' # 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 e3103435..55bc52ab 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,6 +1,6 @@ -========================== -stx-upstream Release Notes -========================== +================================ +StarlingX Upstream Release Notes +================================ .. toctree:: :maxdepth: 2