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 release notes: 1. Standardize page title reST markup 2. Remove search (make consistent with other openstack release note pages) Change-Id: I0bbd0812f4f2132193724feb9b18910389dc85f4 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
parent
4bf75f16ce
commit
009bd77d75
@ -2,14 +2,14 @@
|
||||
stx-config API Reference
|
||||
========================
|
||||
|
||||
StarlingX System Configuration Management
|
||||
Use the StarlingX stx-config API for system configuration management.
|
||||
|
||||
stx-config API content can be searched using the :ref:`search page <search>`.
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
api-ref-sysinv-v1-config
|
||||
|
||||
Search
|
||||
------
|
||||
|
||||
:ref:`search`
|
||||
|
@ -1,11 +1,8 @@
|
||||
========================
|
||||
stx-config Documentation
|
||||
========================
|
||||
|
||||
StarlingX System Configuration Management
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
This is the documentation for StarlingX system configuration management.
|
||||
|
||||
Release Notes
|
||||
-------------
|
||||
@ -24,7 +21,7 @@ API Reference
|
||||
API Reference <https://docs.starlingx.io/api-ref/stx-config>
|
||||
|
||||
Links
|
||||
=====
|
||||
-----
|
||||
|
||||
* Source: `stx-config`_
|
||||
* Code Review: `Gerrit`_
|
||||
@ -33,9 +30,3 @@ Links
|
||||
.. _stx-config: https://git.starlingx.io/cgit/stx-config/
|
||||
.. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-config
|
||||
.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-config
|
||||
|
||||
Indices and Tables
|
||||
==================
|
||||
|
||||
* :ref:`search`
|
||||
* :ref:`genindex`
|
||||
|
@ -1,3 +1,4 @@
|
||||
========================
|
||||
stx-config Release Notes
|
||||
========================
|
||||
|
||||
@ -5,8 +6,3 @@ stx-config Release Notes
|
||||
:maxdepth: 2
|
||||
|
||||
unreleased
|
||||
|
||||
Search
|
||||
------
|
||||
|
||||
:ref:`search`
|
||||
|
Loading…
Reference in New Issue
Block a user