Merge "Update landing pages for docs, api-ref, and release notes:"

api-ref/source/conf.py

@@ -20,7 +20,7 @@ extensions = [
     'os_api_ref',
 ]
 
-html_theme = 'openstackdocs'
+html_theme = 'starlingxdocs'
 
 html_theme_options = {
     "sidebar_dropdown": "api_ref",
@@ -42,7 +42,7 @@ master_doc = 'index'
 
 # General information about the project.
 repository_name = 'openstack/stx-update'
-project = u'stx-update'
+project = u'StarlingX Update'
 bug_project = 'starlingx'
 bug_tag = 'stx.update'
 

api-ref/source/index.rst

@@ -1,8 +1,15 @@
-========================
+====================
-stx-update API Reference
+Update API Reference
-========================
+====================
 
-StarlingX Installation/Update/Patching/Backup/Restore
+Use the StarlingX Update API to manage patching of hosts including installation,
+update, patching, backup, and restore.
+
+Search Update API content using the :ref:`search page <search>`.
+
+-------------
+API reference
+-------------
 
 .. toctree::
    :maxdepth: 2

doc/source/conf.py

@@ -23,7 +23,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = u'stx-update'
+project = u'StarlingX Update'
 copyright = u'2018, StarlingX'
 author = u'StarlingX'
 

doc/source/index.rst

@@ -1,34 +1,36 @@
 ========================
-stx-update Documentation
+StarlingX Update Project
 ========================
 
-The StarlingX stx-update project provides software patch
+The starlingx/update project provides software patch (bug fix) management and
-(bug fix) management and deployment, as well as software release upgrade
+deployment, as well as software release upgrade management.
-management.
 
-Release Notes
+-------------
+Release notes
 -------------
 
 .. toctree::
    :maxdepth: 1
 
-   Release Notes <https://docs.starlingx.io/releasenotes/stx-update>
+   Release notes <https://docs.starlingx.io/releasenotes/update>
 
-API Reference
+-------------
+API reference
 -------------
 
 .. toctree::
    :maxdepth: 1
 
-   API Reference <https://docs.starlingx.io/api-ref/stx-update>
+   API reference <https://docs.starlingx.io/api-ref/update>
 
+-----
 Links
 -----
 
-* Source: `stx-update`_
+* Source: `starlingx/update`_
-* Code Review: `Gerrit`_
+* Code review: `Gerrit`_
-* Bugs: `Storyboard`_
+* Project tracking: `Storyboard`_
 
-.. _stx-update: https://opendev.org/starlingx/update
+.. _starlingx/update: https://opendev.org/starlingx/update
 .. _Gerrit: https://review.opendev.org/#/q/project:starlingx/update
 .. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/update

releasenotes/source/conf.py

@@ -46,7 +46,7 @@ source_suffix = '.rst'
 # The master toctree document.
 master_doc = 'index'
 
-project = 'stx-update'
+project = u'StarlingX Update'
 
 # Release notes are version independent, no need to set version and release
 release = ''

releasenotes/source/index.rst

@@ -1,6 +1,6 @@
-========================
+==============================
-stx-update Release Notes
+StarlingX Update Release Notes
-========================
+==============================
 
 .. toctree::
    :maxdepth: 2