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:38341 Change-Id: I4369fef2a401810ff9cc9a443a3f0572fc327174 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
parent
44cdc55fd8
commit
27eb673b1c
@ -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'
|
||||
|
||||
|
@ -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
|
||||
|
@ -23,7 +23,7 @@
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = u'stx-update'
|
||||
project = u'StarlingX Update'
|
||||
copyright = u'2018, StarlingX'
|
||||
author = u'StarlingX'
|
||||
|
||||
|
@ -1,34 +1,36 @@
|
||||
========================
|
||||
stx-update Documentation
|
||||
StarlingX Update Project
|
||||
========================
|
||||
|
||||
The StarlingX stx-update project provides software patch
|
||||
(bug fix) management and deployment, as well as software release upgrade
|
||||
management.
|
||||
The starlingx/update project provides software patch (bug fix) management and
|
||||
deployment, as well as software release upgrade 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`_
|
||||
* Code Review: `Gerrit`_
|
||||
* Bugs: `Storyboard`_
|
||||
* Source: `starlingx/update`_
|
||||
* Code review: `Gerrit`_
|
||||
* 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
|
||||
|
@ -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 = ''
|
||||
|
@ -1,6 +1,6 @@
|
||||
========================
|
||||
stx-update Release Notes
|
||||
========================
|
||||
==============================
|
||||
StarlingX Update Release Notes
|
||||
==============================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
Loading…
x
Reference in New Issue
Block a user