From 27eb673b1c5ac384cbc51f51e1f404d681a7cb80 Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Wed, 15 Jan 2020 15:55:29 -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:38341 Change-Id: I4369fef2a401810ff9cc9a443a3f0572fc327174 Signed-off-by: Kristal Dale --- api-ref/source/conf.py | 4 ++-- api-ref/source/index.rst | 15 +++++++++++---- doc/source/conf.py | 2 +- doc/source/index.rst | 26 ++++++++++++++------------ releasenotes/source/conf.py | 2 +- releasenotes/source/index.rst | 6 +++--- 6 files changed, 32 insertions(+), 23 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index a40bab8c..02577ee8 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -20,7 +20,7 @@ extensions = [ 'os_api_ref', ] -html_theme = 'openstackdocs' +html_theme = 'starlingxdocs' html_theme_options = { "sidebar_dropdown": "api_ref", @@ -42,7 +42,7 @@ master_doc = 'index' # General information about the project. repository_name = 'openstack/stx-update' -project = u'stx-update' +project = u'StarlingX Update' bug_project = 'starlingx' bug_tag = 'stx.update' diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 53fe2db4..21b41fc0 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -1,8 +1,15 @@ -======================== -stx-update API Reference -======================== +==================== +Update API Reference +==================== -StarlingX Installation/Update/Patching/Backup/Restore +Use the StarlingX Update API to manage patching of hosts including installation, +update, patching, backup, and restore. + +Search Update API content using the :ref:`search page `. + +------------- +API reference +------------- .. toctree:: :maxdepth: 2 diff --git a/doc/source/conf.py b/doc/source/conf.py index 3406fa74..eeb05928 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,7 @@ # -- Project information ----------------------------------------------------- -project = u'stx-update' +project = u'StarlingX Update' copyright = u'2018, StarlingX' author = u'StarlingX' diff --git a/doc/source/index.rst b/doc/source/index.rst index acecc4c7..a16b403b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,34 +1,36 @@ ======================== -stx-update Documentation +StarlingX Update Project ======================== -The StarlingX stx-update project provides software patch -(bug fix) management and deployment, as well as software release upgrade -management. +The starlingx/update project provides software patch (bug fix) management and +deployment, as well as software release upgrade 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-update`_ -* Code Review: `Gerrit`_ -* Bugs: `Storyboard`_ +* Source: `starlingx/update`_ +* Code review: `Gerrit`_ +* Project tracking: `Storyboard`_ -.. _stx-update: https://opendev.org/starlingx/update +.. _starlingx/update: https://opendev.org/starlingx/update .. _Gerrit: https://review.opendev.org/#/q/project:starlingx/update .. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/update diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index d896d10b..7e5a499b 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-update' +project = u'StarlingX Update' # 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 1fc6efe3..e595e081 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,6 +1,6 @@ -======================== -stx-update Release Notes -======================== +============================== +StarlingX Update Release Notes +============================== .. toctree:: :maxdepth: 2