From 5c13295994f03bad3e0b25c4d87690552228ac8c Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Wed, 15 Jan 2020 15:39:25 -0800 Subject: [PATCH] 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 --- api-ref/source/conf.py | 2 +- api-ref/source/index.rst | 13 +++++++------ doc/source/conf.py | 2 +- doc/source/index.rst | 23 +++++++++++++---------- releasenotes/source/conf.py | 2 +- releasenotes/source/index.rst | 6 +++--- 6 files changed, 26 insertions(+), 22 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 6c668765..5d2bb227 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -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' diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 3f910cba..5f997ee9 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -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 NFV API content using the :ref:`search page `. -API Reference +------------- +API reference ------------- .. toctree:: diff --git a/doc/source/conf.py b/doc/source/conf.py index 04c494dd..ba7aba6d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,7 @@ # -- Project information ----------------------------------------------------- -project = u'stx-nfv' +project = u'StarlingX NFV' copyright = u'2018, StarlingX' author = u'StarlingX' diff --git a/doc/source/index.rst b/doc/source/index.rst index 7b613ef9..34b752fc 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 + Release notes -API Reference +------------- +API reference ------------- .. toctree:: :maxdepth: 1 - API Reference + API reference +----- 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 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index e7dfe971..9765cb06 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -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 = '' diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index a11ee4d8..13d8ebea 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,6 +1,6 @@ -===================== -stx-nfv Release Notes -===================== +=========================== +StarlingX NFV Release Notes +=========================== .. toctree:: :maxdepth: 2