diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index efa3b580..a791138a 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -1,13 +1,16 @@ -======================= +==================== stx-ha API Reference -======================= +==================== -This is the API Reference for the StarlingX High Availability / Process -Monitoring / Service Management +Use the StarlingX stx-ha API to manage high availability services running +on the StarlingX OpenStack controller cluster. + +stx-ha API content can be searched using the :ref:`search page `. + +API Reference +------------- .. toctree:: :maxdepth: 2 api-ref-smapi-v1-ha - -:ref:`search` diff --git a/doc/source/index.rst b/doc/source/index.rst index e7196d66..6a88456e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,11 +1,9 @@ +==================== stx-ha Documentation ==================== -StarlingX High Availability / Process Monitoring / Service Management - -.. toctree:: - :maxdepth: 2 - :caption: Contents: +The StarlingX stx-ha project provides high availability cluster management +for StarlingX and OpenStack services on controllers. Release Notes ------------- @@ -24,7 +22,7 @@ API Reference API Reference Links -===== +----- * Source: `stx-ha`_ * Code Review: `Gerrit`_ @@ -33,9 +31,3 @@ Links .. _stx-ha: https://git.starlingx.io/cgit/stx-ha/ .. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-ha .. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-ha - -Indices and Tables -================== - -* :ref:`search` -* :ref:`genindex` diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index c28fe15b..a3d41248 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -1,9 +1,8 @@ +==================== stx-ha Release Notes -======================= +==================== .. toctree:: :maxdepth: 2 unreleased - -:ref:`search`