From d75d427c11db3ec2f225a8dd1e3a2ec5a008e96f Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Wed, 15 Jan 2020 13:35:52 -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 patch 5: Update to use 'Metal' instead of 'Bare Metal' per comments Story:2007193 Task:38340 Change-Id: I22aa2f15850d4b5ecf01fd78c015b772b87a4932 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 | 24 +++++++++++++----------- releasenotes/source/conf.py | 2 +- releasenotes/source/index.rst | 6 +++--- 6 files changed, 26 insertions(+), 23 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 01f7c4e5..6dc28d90 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -42,7 +42,7 @@ master_doc = 'index' # General information about the project. repository_name = 'openstack/stx-metal' -project = u'stx-metal' +project = u'StarlingX Metal' bug_project = 'starlingx' bug_tag = 'stx.metal' diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index d16806b4..9fe7acdd 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -1,12 +1,13 @@ -======================= -stx-metal API Reference -======================= +=================== +Metal API Reference +=================== -Use the StarlingX stx-metal API to maintain and manage physical hosts. +Use the StarlingX Metal API to maintain and manage physical hosts. -stx-metal API content can be searched using the :ref:`search page `. +Search Metal 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 d734b81b..52b23edf 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -20,7 +20,7 @@ # -- Project information ----------------------------------------------------- -project = u'stx-metal' +project = u'StarlingX Metal' copyright = u'2018, StarlingX' author = u'StarlingX' diff --git a/doc/source/index.rst b/doc/source/index.rst index 2ca5cf50..e1af278b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,33 +1,35 @@ ======================= -stx-metal Documentation +StarlingX Metal Project ======================= -The StarlingX stx-metal project provides physical host maintenance and -management. +The starlingX/metal project provides physical host maintenance and 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-metal`_ -* Code Review: `Gerrit`_ -* Bugs: `Storyboard`_ +* Source: `starlingx/metal`_ +* Code review: `Gerrit`_ +* Project tracking: `Storyboard`_ -.. _stx-metal: https://opendev.org/starlingx/metal +.. _starlingx/metal: https://opendev.org/starlingx/metal .. _Gerrit: https://review.opendev.org/#/q/project:starlingx/metal .. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/metal diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 6311d072..9001e4ce 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -47,7 +47,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = 'stx-metal' +project = u'StarlingX Metal' # 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 151cdc5b..74767c6e 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,6 +1,6 @@ -======================= -stx-metal Release Notes -======================= +============================= +StarlingX Metal Release Notes +============================= .. toctree:: :maxdepth: 2