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:38337 Change-Id: I03de3548572d3b5f2f68cfa6105ed876c973b5e6 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
parent
3a58bf68a1
commit
6f0ed2e8fd
@ -42,7 +42,7 @@ master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
repository_name = 'openstack/stx-fault'
|
||||
project = u'stx-fault'
|
||||
project = u'StarlingX Fault Management'
|
||||
bug_project = 'starlingx'
|
||||
bug_tag = 'stx.fault'
|
||||
|
||||
|
@ -1,12 +1,14 @@
|
||||
=======================
|
||||
stx-fault API Reference
|
||||
=======================
|
||||
==============================
|
||||
Fault Management API Reference
|
||||
==============================
|
||||
|
||||
Use the StarlingX stx-fault API for alarm and event collection of the cloud platform.
|
||||
Use the StarlingX Fault Management API for alarm and event collection of the
|
||||
cloud platform.
|
||||
|
||||
stx-fault API content can be searched using the :ref:`search page <search>`.
|
||||
Search Fault Management API content using the :ref:`search page <search>`.
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
API reference
|
||||
-------------
|
||||
|
||||
.. toctree::
|
||||
|
@ -23,7 +23,7 @@
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = u'stx-fault'
|
||||
project = u'StarlingX Fault Management'
|
||||
copyright = u'2018, StarlingX'
|
||||
author = u'StarlingX'
|
||||
|
||||
|
@ -1,8 +1,8 @@
|
||||
=======================
|
||||
stx-fault Documentation
|
||||
=======================
|
||||
==================================
|
||||
StarlingX Fault Management Project
|
||||
==================================
|
||||
|
||||
Following is the documentation for StarlingX fault management.
|
||||
The starlingx/fault project provides fault management.
|
||||
|
||||
--------
|
||||
Overview
|
||||
@ -61,31 +61,31 @@ Finally, the StarlingX dashboard includes a view/panel that allows you to more
|
||||
easily view and interpret FM operations.
|
||||
|
||||
-------------
|
||||
Release Notes
|
||||
Release notes
|
||||
-------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Release Notes <https://docs.starlingx.io/releasenotes/stx-fault>
|
||||
Release notes <https://docs.starlingx.io/releasenotes/fault>
|
||||
|
||||
-------------
|
||||
API Reference
|
||||
API reference
|
||||
-------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
API Reference <https://docs.starlingx.io/api-ref/stx-fault>
|
||||
API reference <https://docs.starlingx.io/api-ref/fault>
|
||||
|
||||
-----
|
||||
Links
|
||||
-----
|
||||
|
||||
* Source: `stx-fault`_
|
||||
* Code Review: `Gerrit`_
|
||||
* Bugs: `Storyboard`_
|
||||
* Source: `starlingx/fault`_
|
||||
* Code review: `Gerrit`_
|
||||
* Project tracking: `Storyboard`_
|
||||
|
||||
.. _stx-fault: https://opendev.org/starlingx/fault
|
||||
.. _starlingx/fault: https://opendev.org/starlingx/fault
|
||||
.. _Gerrit: https://review.opendev.org/#/q/project:starlingx/fault
|
||||
.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/fault
|
||||
|
@ -47,7 +47,7 @@ source_suffix = '.rst'
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'stx-fault'
|
||||
project = u'StarlingX Fault Management'
|
||||
|
||||
# Release notes are version independent, no need to set version and release
|
||||
release = ''
|
||||
|
@ -1,6 +1,6 @@
|
||||
=======================
|
||||
stx-fault Release Notes
|
||||
=======================
|
||||
========================================
|
||||
StarlingX Fault Management Release Notes
|
||||
========================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
Loading…
Reference in New Issue
Block a user