Browse Source

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)

Story: 2004737
Task: 28803

Change-Id: I11ba3784a5d50953d62f0bc4a08f3f2b308da6b5
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Kristal Dale 3 months ago
parent
commit
6cd39f8226
3 changed files with 11 additions and 17 deletions
  1. 6
    3
      api-ref/source/index.rst
  2. 4
    12
      doc/source/index.rst
  3. 1
    2
      releasenotes/source/index.rst

+ 6
- 3
api-ref/source/index.rst View File

@@ -2,11 +2,14 @@
2 2
 stx-distcloud API Reference
3 3
 ===========================
4 4
 
5
-StarlingX Distributed Cloud
5
+Use the StarlingX stx-distcloud API to manage distributed cloud operations.
6
+
7
+stx-distcloud API content can be searched using the :ref:`search page <search>`.
8
+
9
+API Reference
10
+-------------
6 11
 
7 12
 .. toctree::
8 13
    :maxdepth: 2
9 14
 
10 15
    api-ref-dcmanager-v1
11
-
12
-:ref:`search`

+ 4
- 12
doc/source/index.rst View File

@@ -1,11 +1,9 @@
1
+===========================
1 2
 stx-distcloud Documentation
2 3
 ===========================
3 4
 
4
-StarlingX Distributed Cloud
5
-
6
-.. toctree::
7
-   :maxdepth: 2
8
-   :caption: Contents:
5
+The StarlingX stx-distcloud project provides management for distributed
6
+cloud operations.
9 7
 
10 8
 Release Notes
11 9
 -------------
@@ -24,7 +22,7 @@ API Reference
24 22
    API Reference <https://docs.starlingx.io/api-ref/stx-distcloud>
25 23
 
26 24
 Links
27
-=====
25
+-----
28 26
 
29 27
 * Source: `stx-distcloud`_
30 28
 * Code Review: `Gerrit`_
@@ -33,9 +31,3 @@ Links
33 31
 .. _stx-distcloud: https://git.starlingx.io/cgit/stx-distcloud/
34 32
 .. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-distcloud
35 33
 .. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-distcloud
36
-
37
-Indices and Tables
38
-==================
39
-
40
-* :ref:`search`
41
-* :ref:`genindex`

+ 1
- 2
releasenotes/source/index.rst View File

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

Loading…
Cancel
Save