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
- Add missing section (docs) to bring inline with other pages
- Update project name in link to release notes
- Update project name in config for docs/releasenotes

Story:2007193
Task:38249

Change-Id: I3a336184cadf910bd66ce4d3349917fc530dcbde
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2020-01-17 14:04:53 -08:00
parent ce63cccc14
commit 5e3f0fdfb7
4 changed files with 21 additions and 17 deletions

View File

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

View File

@ -1,25 +1,28 @@
stx-clients Documentation =========================
StarlingX Clients Project
========================= =========================
StarlingX Client Libraries The starlingx/clients project provides client libraries.
-------------
Release notes
-------------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: Contents:
Release notes <https://docs.starlingx.io/releasenotes/clients>
-----
Links Links
===== -----
* Source: `stx-clients`_ * Source: `starlingx/clients`_
* Code Review: `Gerrit`_ * Code review: `Gerrit`_
* Bugs: `Storyboard`_ * Project tracking: `Storyboard`_
.. _stx-clients: https://opendev.org/starlingx/clients .. _starlingx/clients: https://opendev.org/starlingx/clients
.. _Gerrit: https://review.opendev.org/#/q/project:starlingx/clients .. _Gerrit: https://review.opendev.org/#/q/project:starlingx/clients
.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/clients .. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/clients
Indices and Tables
==================
* :ref:`search`
* :ref:`genindex`

View File

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