Merge "Update landing pages for docs, api-ref, and release notes:"
This commit is contained in:
commit
59ef6619e2
@ -42,7 +42,7 @@ master_doc = 'index'
|
|||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
repository_name = 'openstack/stx-fault'
|
repository_name = 'openstack/stx-fault'
|
||||||
project = u'stx-fault'
|
project = u'StarlingX Fault Management'
|
||||||
bug_project = 'starlingx'
|
bug_project = 'starlingx'
|
||||||
bug_tag = 'stx.fault'
|
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::
|
.. toctree::
|
||||||
|
@ -23,7 +23,7 @@
|
|||||||
|
|
||||||
# -- Project information -----------------------------------------------------
|
# -- Project information -----------------------------------------------------
|
||||||
|
|
||||||
project = u'stx-fault'
|
project = u'StarlingX Fault Management'
|
||||||
copyright = u'2018, StarlingX'
|
copyright = u'2018, StarlingX'
|
||||||
author = u'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
|
Overview
|
||||||
@ -61,31 +61,31 @@ Finally, the StarlingX dashboard includes a view/panel that allows you to more
|
|||||||
easily view and interpret FM operations.
|
easily view and interpret FM operations.
|
||||||
|
|
||||||
-------------
|
-------------
|
||||||
Release Notes
|
Release notes
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
Release Notes <https://docs.starlingx.io/releasenotes/stx-fault>
|
Release notes <https://docs.starlingx.io/releasenotes/fault>
|
||||||
|
|
||||||
-------------
|
-------------
|
||||||
API Reference
|
API reference
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
API Reference <https://docs.starlingx.io/api-ref/stx-fault>
|
API reference <https://docs.starlingx.io/api-ref/fault>
|
||||||
|
|
||||||
-----
|
-----
|
||||||
Links
|
Links
|
||||||
-----
|
-----
|
||||||
|
|
||||||
* Source: `stx-fault`_
|
* Source: `starlingx/fault`_
|
||||||
* Code Review: `Gerrit`_
|
* Code review: `Gerrit`_
|
||||||
* Bugs: `Storyboard`_
|
* 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
|
.. _Gerrit: https://review.opendev.org/#/q/project:starlingx/fault
|
||||||
.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/fault
|
.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/fault
|
||||||
|
@ -47,7 +47,7 @@ source_suffix = '.rst'
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# 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 notes are version independent, no need to set version and release
|
||||||
release = ''
|
release = ''
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
=======================
|
========================================
|
||||||
stx-fault Release Notes
|
StarlingX Fault Management Release Notes
|
||||||
=======================
|
========================================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
Loading…
Reference in New Issue
Block a user