starlingx
/
nfv
Code Issues Proposed changes

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)

Change-Id: Ia12c5b865f3e4c973a7f403bbf787e7c91bf34a3
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale 2018-12-27 17:10:05 -08:00
parent 86601b800c
commit 37240fa085
3 changed files with 10 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api-ref/source/index.rst
View File

@ -2,11 +2,14 @@
stx-nfv API Reference stx-nfv API Reference
===================== =====================
StarlingX NFVI Orchestration Use the StarlingX stx-nfv API for NFVI orchestration.
stx-nfv API content can be searched using the :ref:`search page <search>`.
API Reference
-------------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
api-ref-nfv-vim-v1 api-ref-nfv-vim-v1
:ref:`search`

15
doc/source/index.rst
View File

@ -1,11 +1,8 @@
=====================
stx-nfv Documentation stx-nfv Documentation
===================== =====================
StarlingX NFVI Orchestration This is the documentation for StarlingX NFVI orchestration.
.. toctree::
:maxdepth: 2
:caption: Contents:
Release Notes Release Notes
------------- -------------
@ -24,7 +21,7 @@ API Reference
API Reference <https://docs.starlingx.io/api-ref/stx-nfv> API Reference <https://docs.starlingx.io/api-ref/stx-nfv>
Links Links
===== -----
* Source: `stx-nfv`_ * Source: `stx-nfv`_
* Code Review: `Gerrit`_ * Code Review: `Gerrit`_
@ -33,9 +30,3 @@ Links
.. _stx-nfv: https://git.starlingx.io/cgit/stx-nfv/ .. _stx-nfv: https://git.starlingx.io/cgit/stx-nfv/
.. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-nfv .. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-nfv
.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-nfv .. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-nfv
Indices and Tables
==================
* :ref:`search`
* :ref:`genindex`

3
releasenotes/source/index.rst
View File

@ -1,3 +1,4 @@
=====================
stx-nfv Release Notes stx-nfv Release Notes
===================== =====================
@ -5,5 +6,3 @@ stx-nfv Release Notes
:maxdepth: 2 :maxdepth: 2
unreleased unreleased
:ref:`search`