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:38346 Change-Id: I15af375869bb03120fed052ecc5ce070a5581125 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
parent
3cdea4f02b
commit
5c13295994
@ -42,7 +42,7 @@ master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
repository_name = 'openstack/stx-nfv'
|
||||
project = u'stx-nfv'
|
||||
project = u'StarlingX NFV'
|
||||
bug_project = 'starlingx'
|
||||
bug_tag = 'stx.nfv'
|
||||
|
||||
|
@ -1,12 +1,13 @@
|
||||
=====================
|
||||
stx-nfv API Reference
|
||||
=====================
|
||||
=================
|
||||
NFV API Reference
|
||||
=================
|
||||
|
||||
Use the StarlingX stx-nfv API for NFVI orchestration.
|
||||
Use the StarlingX NFV API for NFVI orchestration.
|
||||
|
||||
stx-nfv API content can be searched using the :ref:`search page <search>`.
|
||||
Search NFV API content using the :ref:`search page <search>`.
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
API reference
|
||||
-------------
|
||||
|
||||
.. toctree::
|
||||
|
@ -23,7 +23,7 @@
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = u'stx-nfv'
|
||||
project = u'StarlingX NFV'
|
||||
copyright = u'2018, StarlingX'
|
||||
author = u'StarlingX'
|
||||
|
||||
|
@ -1,32 +1,35 @@
|
||||
=====================
|
||||
stx-nfv Documentation
|
||||
StarlingX NFV Project
|
||||
=====================
|
||||
|
||||
This is the documentation for StarlingX NFVI orchestration.
|
||||
The starlingx/nfv project provides NFVI orchestration.
|
||||
|
||||
Release Notes
|
||||
-------------
|
||||
Release notes
|
||||
-------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Release Notes <https://docs.starlingx.io/releasenotes/stx-nfv>
|
||||
Release notes <https://docs.starlingx.io/releasenotes/nfv>
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
API reference
|
||||
-------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
API Reference <https://docs.starlingx.io/api-ref/stx-nfv>
|
||||
API reference <https://docs.starlingx.io/api-ref/nfv>
|
||||
|
||||
-----
|
||||
Links
|
||||
-----
|
||||
|
||||
* Source: `stx-nfv`_
|
||||
* Code Review: `Gerrit`_
|
||||
* Bugs: `Storyboard`_
|
||||
* Source: `starlingx/nfv`_
|
||||
* Code review: `Gerrit`_
|
||||
* Project tracking: `Storyboard`_
|
||||
|
||||
.. _stx-nfv: https://opendev.org/starlingx/nfv/
|
||||
.. _starlingx/nfv: https://opendev.org/starlingx/nfv/
|
||||
.. _Gerrit: https://review.opendev.org/#/q/project:starlingx/nfv
|
||||
.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/nfv
|
||||
|
@ -47,7 +47,7 @@ source_suffix = '.rst'
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'stx-nfv'
|
||||
project = u'StarlingX NFV'
|
||||
|
||||
# Release notes are version independent, no need to set version and release
|
||||
release = ''
|
||||
|
@ -1,6 +1,6 @@
|
||||
=====================
|
||||
stx-nfv Release Notes
|
||||
=====================
|
||||
===========================
|
||||
StarlingX NFV Release Notes
|
||||
===========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
Loading…
x
Reference in New Issue
Block a user