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 <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2020-01-17 14:10:55 -08:00
parent 5ccf5648d8
commit 53914fc55c
4 changed files with 17 additions and 15 deletions

View File

@ -23,7 +23,7 @@
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = u'stx-integ' project = u'StarlingX Integration'
copyright = u'2018, StarlingX' copyright = u'2018, StarlingX'
author = u'StarlingX' author = u'StarlingX'

View File

@ -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:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Release Notes <https://docs.starlingx.io/releasenotes/stx-integ> Release notes <https://docs.starlingx.io/releasenotes/integ>
-----
Links Links
----- -----
* Source: `stx-integ`_ * Source: `starlingx/integ`_
* Code Review: `Gerrit`_ * Code review: `Gerrit`_
* Bugs: `Storyboard`_ * 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 .. _Gerrit: https://review.opendev.org/#/q/project:starlingx/integ
.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/integ .. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/integ

View File

@ -46,7 +46,7 @@ source_suffix = '.rst'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
project = u'stx-integ' project = u'StarlingX Integration'
# 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-integ Release Notes StarlingX Integration Release Notes
======================= ===================================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2