Browse Source

Clean up and standardize landing pages

doc index.rst:
1. Correct heading levels (impacting side nav and correct rendering of content)
2. Remove "Indices and Tables" section: genindex page not used, move search link to intro sentence.

spec instructions.rst:
1. Update page title to be consistent w/ incoming link text (so that link with text "How to submit a spec" goes to a page titled "Submit a Spec")
2. Add section header to first list on page

Change-Id: Ic3071bcf1c8d152c68d6735f08bb97e768aa944f
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Kristal Dale 3 months ago
parent
commit
1161e686ec
2 changed files with 13 additions and 10 deletions
  1. 8
    8
      doc/source/index.rst
  2. 5
    2
      specs/instructions.rst

+ 8
- 8
doc/source/index.rst View File

@@ -4,10 +4,15 @@
4 4
 OpenStack StarlingX Project Plans
5 5
 =================================
6 6
 
7
+Learn more about StarlingX project specifications for specific relseases
8
+and the process to submit a specification.
9
+
10
+Specification content can be searched using the :ref:`search page <search>`.
11
+
7 12
 Specifications
8
-==============
13
+--------------
9 14
 
10
-Here you can find the specs, and spec template, for each release:
15
+Here you can find the specs and spec template for each release:
11 16
 
12 17
 .. toctree::
13 18
    :glob:
@@ -16,7 +21,7 @@ Here you can find the specs, and spec template, for each release:
16 21
    specs/2019.03/index
17 22
 
18 23
 Process
19
-=======
24
+-------
20 25
 
21 26
 Documentation for stx-specs process:
22 27
 
@@ -27,8 +32,3 @@ Documentation for stx-specs process:
27 32
 
28 33
 For more details, look at spec template for the specific release, and see the
29 34
 wiki page on Blueprints: https://wiki.openstack.org/wiki/Blueprints
30
-
31
-Indices and tables
32
-==================
33
-
34
-* :ref:`search`

+ 5
- 2
specs/instructions.rst View File

@@ -10,9 +10,12 @@
10 10
 
11 11
 .. _instructions:
12 12
 
13
-============
13
+=============
14
+Submit a Spec
15
+=============
16
+
14 17
 Instructions
15
-============
18
+------------
16 19
 
17 20
 - Use STX_Example_Spec.rst under the ``approved`` subfolder of the applicable
18 21
   release as the basis of your specification.

Loading…
Cancel
Save