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:38342 Change-Id: I65d4b92deef90c09f7c1f309bf79e454c570c8a1 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
parent
ab11f85898
commit
54ed99eb3c
@ -51,7 +51,7 @@ master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
repository_name = 'openstack/stx-distcloud'
|
||||
project = u'stx-distcloud'
|
||||
project = u'StarlingX Distributed Cloud'
|
||||
bug_project = 'starlingx'
|
||||
bug_tag = 'stx.distcloud'
|
||||
|
||||
|
@ -1,12 +1,14 @@
|
||||
===========================
|
||||
stx-distcloud API Reference
|
||||
===========================
|
||||
===============================
|
||||
Distributed Cloud API Reference
|
||||
===============================
|
||||
|
||||
Use the StarlingX stx-distcloud API to manage distributed cloud operations.
|
||||
Use the StarlingX Distributed Cloud API to manage distributed cloud
|
||||
operations.
|
||||
|
||||
stx-distcloud API content can be searched using the :ref:`search page <search>`.
|
||||
Search Distributed Cloud API content using the :ref:`search page <search>`.
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
API reference
|
||||
-------------
|
||||
|
||||
.. toctree::
|
||||
|
@ -21,7 +21,7 @@
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = u'stx-distcloud'
|
||||
project = u'StarlingX Distributed Cloud'
|
||||
copyright = u'2018, StarlingX'
|
||||
author = u'StarlingX'
|
||||
|
||||
|
@ -1,33 +1,36 @@
|
||||
===========================
|
||||
stx-distcloud Documentation
|
||||
===========================
|
||||
===================================
|
||||
StarlingX Distributed Cloud Project
|
||||
===================================
|
||||
|
||||
The StarlingX stx-distcloud project provides management for distributed
|
||||
The starlingx/distcloud project provides management for distributed
|
||||
cloud operations.
|
||||
|
||||
Release Notes
|
||||
-------------
|
||||
Release notes
|
||||
-------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Release Notes <https://docs.starlingx.io/releasenotes/stx-distcloud>
|
||||
Release notes <https://docs.starlingx.io/releasenotes/distcloud>
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
API reference
|
||||
-------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
API Reference <https://docs.starlingx.io/api-ref/stx-distcloud>
|
||||
API reference <https://docs.starlingx.io/api-ref/distcloud>
|
||||
|
||||
-----
|
||||
Links
|
||||
-----
|
||||
|
||||
* Source: `stx-distcloud`_
|
||||
* Code Review: `Gerrit`_
|
||||
* Bugs: `Storyboard`_
|
||||
* Source: `starlingx/distcloud`_
|
||||
* Code review: `Gerrit`_
|
||||
* Project tracking: `Storyboard`_
|
||||
|
||||
.. _stx-distcloud: https://opendev.org/starlingx/distcloud
|
||||
.. _starlingx/distcloud: https://opendev.org/starlingx/distcloud
|
||||
.. _Gerrit: https://review.opendev.org/#/q/project:starlingx/distcloud
|
||||
.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/distcloud
|
||||
|
@ -41,6 +41,9 @@ extensions = [
|
||||
'reno.sphinxext',
|
||||
]
|
||||
|
||||
# General information about the project.
|
||||
project = u'StarlingX Distributed Cloud'
|
||||
|
||||
bug_project = '1027'
|
||||
bug_tag = 'stx.bug'
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
===========================
|
||||
stx-distcloud Release Notes
|
||||
===========================
|
||||
=========================================
|
||||
StarlingX Distributed Cloud Release Notes
|
||||
=========================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
Loading…
Reference in New Issue
Block a user