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

Change-Id: Ia01582558ab27accb68ccdf00d492f5e79689f04
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2020-01-15 14:42:24 -08:00
parent ca310aaa7b
commit 6d53febf34
6 changed files with 28 additions and 24 deletions

View File

@ -51,7 +51,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
repository_name = 'openstack/stx-config' repository_name = 'openstack/stx-config'
project = u'stx-config' project = u'StarlingX Configuration'
bug_project = 'starlingx' bug_project = 'starlingx'
bug_tag = 'stx.config' bug_tag = 'stx.config'

View File

@ -1,12 +1,13 @@
======================== ===========================
stx-config API Reference Configuration API Reference
======================== ===========================
Use the StarlingX stx-config API for system configuration management. Use the StarlingX Configuration API for system configuration management.
stx-config API content can be searched using the :ref:`search page <search>`. Search Configuration API content using the :ref:`search page <search>`.
API Reference -------------
API reference
------------- -------------
.. toctree:: .. toctree::

View File

@ -21,7 +21,7 @@
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = u'stx-config' project = u'StarlingX Configuration'
copyright = u'2018, StarlingX' copyright = u'2018, StarlingX'
author = u'StarlingX' author = u'StarlingX'

View File

@ -1,32 +1,35 @@
======================== ===============================
stx-config Documentation StarlingX Configuration Project
======================== ===============================
This is the documentation for StarlingX system configuration management. The starlingx/config project provides system configuration management.
Release Notes -------------
Release notes
------------- -------------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Release Notes <https://docs.starlingx.io/releasenotes/stx-config> Release notes <https://docs.starlingx.io/releasenotes/config>
API Reference -------------
API reference
------------- -------------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
API Reference <https://docs.starlingx.io/api-ref/stx-config> API reference <https://docs.starlingx.io/api-ref/config>
-----
Links Links
----- -----
* Source: `stx-config`_ * Source: `starlingx/config`_
* Code Review: `Gerrit`_ * Code review: `Gerrit`_
* Bugs: `Storyboard`_ * Project tracking: `Storyboard`_
.. _stx-config: https://opendev.org/starlingx/config/ .. _starlingx/config: https://opendev.org/starlingx/config/
.. _Gerrit: https://review.opendev.org/#/q/project:starlingx/config .. _Gerrit: https://review.opendev.org/#/q/project:starlingx/config
.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/config .. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/config

View File

@ -57,7 +57,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = 'stx-config' project = u'StarlingX Configuration'
# 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,6 +1,6 @@
======================== =====================================
stx-config Release Notes StarlingX Configuration Release Notes
======================== =====================================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2