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:38348

Change-Id: I4840bfb9c17128e1883e36b8292ce325045b618a
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2020-01-17 13:56:26 -08:00
parent b1449fb4c4
commit 7756b4cfb6
6 changed files with 28 additions and 24 deletions

View File

@ -51,7 +51,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
repository_name = 'openstack/stx-ha' repository_name = 'openstack/stx-ha'
project = u'stx-ha' project = u'StarlingX HA'
bug_project = 'starlingx' bug_project = 'starlingx'
bug_tag = 'stx.ha' bug_tag = 'stx.ha'

View File

@ -1,13 +1,14 @@
==================== =========================
stx-ha API Reference HA Services API Reference
==================== =========================
Use the StarlingX stx-ha API to manage high availability services running Use the StarlingX HA API to manage high availability services running
on the StarlingX OpenStack controller cluster. on the StarlingX OpenStack controller cluster.
stx-ha API content can be searched using the :ref:`search page <search>`. Search HA Services API content using the :ref:`search page <search>`.
API Reference -------------
API reference
------------- -------------
.. toctree:: .. toctree::

View File

@ -21,7 +21,7 @@
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = u'stx-ha' project = u'StarlingX HA'
copyright = u'2018, StarlingX' copyright = u'2018, StarlingX'
author = u'StarlingX' author = u'StarlingX'

View File

@ -1,33 +1,36 @@
==================== =============================
stx-ha Documentation StarlingX HA Services Project
==================== =============================
The StarlingX stx-ha project provides high availability cluster management The starlingx/ha project provides high availability cluster management
for StarlingX and OpenStack services on controllers. for StarlingX and OpenStack services on controllers.
Release Notes -------------
Release notes
------------- -------------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Release Notes <https://docs.starlingx.io/releasenotes/stx-ha> Release notes <https://docs.starlingx.io/releasenotes/ha>
API Reference -------------
API reference
------------- -------------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
API Reference <https://docs.starlingx.io/api-ref/stx-ha> API reference <https://docs.starlingx.io/api-ref/ha>
-----
Links Links
----- -----
* Source: `stx-ha`_ * Source: `starlingx/ha`_
* Code Review: `Gerrit`_ * Code review: `Gerrit`_
* Bugs: `Storyboard`_ * Project tracking: `Storyboard`_
.. _stx-ha: https://opendev.org/starlingx/ha .. _starlingx/ha: https://opendev.org/starlingx/ha
.. _Gerrit: https://review.opendev.org/#/q/project:starlingx/ha .. _Gerrit: https://review.opendev.org/#/q/project:starlingx/ha
.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/ha .. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/ha

View File

@ -57,7 +57,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = 'stx-ha' project = 'StarlingX HA'
# Release notes are version independent, no need to set version and release # Release notes are version independent, no need to set version and release
release = '' release = ''

View File

@ -1,6 +1,6 @@
==================== ===================================
stx-ha Release Notes StarlingX HA Services Release Notes
==================== ===================================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2