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

Change-Id: Ia0359834ba868a680adce74799367a6297343763
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2020-01-17 13:47:13 -08:00
parent 8af6598d13
commit bb08f17062
4 changed files with 22 additions and 15 deletions

View File

@ -23,7 +23,7 @@
# -- Project information -----------------------------------------------------
project = u'stx-distcloud-client'
project = u'StarlingX Distributed Cloud Client'
copyright = u'2018, StarlingX'
author = u'StarlingX'

View File

@ -1,25 +1,27 @@
==================================
stx-distcloud-client Documentation
==================================
==========================================
StarlingX Distributed Cloud Client Project
==========================================
The StarlingX stx-distcloud-client project provides client functionality
for StarlingX distributed cloud.
The starlingx/distcloud-client project provides client functionality
for the StarlingX distributed cloud.
Release Notes
-------------
Release notes
-------------
.. toctree::
:maxdepth: 1
Release Notes <https://docs.starlingx.io/releasenotes/stx-distcloud-client>
Release notes <https://docs.starlingx.io/releasenotes/distcloud-client>
-----
Links
-----
* Source: `stx-distcloud-client`_
* Code Review: `Gerrit`_
* Bugs: `Storyboard`_
* Source: `starlingx/distcloud-client`_
* Code review: `Gerrit`_
* Project tracking: `Storyboard`_
.. _stx-distcloud-client: https://opendev.org/starlingx/distcloud-client
.. _starlingx/distcloud-client: https://opendev.org/starlingx/distcloud-client
.. _Gerrit: https://review.opendev.org/#/q/project:starlingx/distcloud-client
.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/distcloud-client

View File

@ -31,6 +31,11 @@ extensions = [
'reno.sphinxext',
]
# -- Project information -----------------------------------------------------
project = u'StarlingX Distributed Cloud Client'
bug_project = '1027'
bug_tag = 'stx.bug'

View File

@ -1,6 +1,6 @@
==================================
stx-distcloud-client Release Notes
==================================
================================================
StarlingX Distributed Cloud Client Release Notes
================================================
.. toctree::
:maxdepth: 2