metal/doc/source/index.rst
Kristal Dale 3522ead301 Clean up and standardize landing pages
doc index.rst:
1. Update intro sentence to read as a complete sentence
2. Remove unused toctree
3. Correct heading levels (impacting side nav and correct rendering
of content)
4. Remove "Indices and Tables" section: genindex page not used,
search searches only index (not useful here)

api-ref index.rst:
1. Update intro sentence to read as a complete sentence
2. Update text around search link for consistency (move to
follow intro)
3. Add heading before toctree for consistency with other pages

releasenotes index.rst:
1. Standardize page title reST markup
2. Remove search (make consistent with other openstack release
note pages)

Story: 2004737
Task: 28805

Change-Id: I388cc5d69db56e6e94bf034ece2478933c9d9c1e
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-09 09:34:38 -08:00

34 lines
701 B
ReStructuredText

=======================
stx-metal Documentation
=======================
The StarlingX stx-metal project provides physical host maintenance and
management.
Release Notes
-------------
.. toctree::
:maxdepth: 1
Release Notes <https://docs.starlingx.io/releasenotes/stx-metal>
API Reference
-------------
.. toctree::
:maxdepth: 1
API Reference <https://docs.starlingx.io/api-ref/stx-metal>
Links
-----
* Source: `stx-metal`_
* Code Review: `Gerrit`_
* Bugs: `Storyboard`_
.. _stx-metal: https://git.starlingx.io/cgit/stx-metal/
.. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-metal
.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-metal